Twkeed Code CLI

Twkeed Code is an AI-powered CLI that brings intelligent software development assistance directly into your terminal. It provides powerful AI capabilities for code generation, analysis, and automation.

🚀 Why Twkeed Code?

• 🤖 AI-Powered: Advanced AI assistance for code generation and analysis
• 🧠 Large Context: Access to 1M token context window for complex projects
• 🔧 Built-in Tools: File operations, shell commands, web fetching, and more
• 🔌 Extensible: MCP (Model Context Protocol) support for custom integrations
• 💻 Terminal-First: Designed for developers who live in the command line
• 🎨 Clean Design: Minimalist white-themed interface representing Twkeed's brand
• 🛡️ Open Source: Apache 2.0 licensed

📦 Installation

Prerequisites

• Node.js version 20 or higher
• macOS, Linux, or Windows

Quick Install

Install globally with npm

npm install -g twkeed-code

Run instantly with npx

npx twkeed-code

📋 Key Features

Code Understanding & Generation

• Query and edit large codebases with AI assistance
• Generate new applications from specifications
• Debug issues and troubleshoot with natural language
• Multimodal capabilities for processing images and documents

Automation & Integration

• Automate operational tasks and complex workflows
• Use MCP servers to connect new capabilities
• Run non-interactively in scripts for workflow automation
• Integrate with your existing development tools

Advanced Capabilities

• Real-time information access through web search
• Conversation checkpointing to save and resume complex sessions
• Custom context files (TWKEED.md) to tailor behavior for your projects
• Support for multiple directories and large codebases

🔐 Authentication

Setting up your API Key

Twkeed Code requires an API key for operation:

# Set your API key
export TWKEED_API_KEY="YOUR_API_KEY"

# Start Twkeed Code
twkeed

Get your API key from Twkeed Dashboard

🚀 Getting Started

Basic Usage

Start in current directory

twkeed

Include multiple directories

twkeed --include-directories ../lib,../docs

Use specific model

twkeed -m model-2.5-flash

Non-interactive mode for scripts

Get a simple text response:

twkeed "Explain the architecture of this codebase"

For structured output in scripts:

twkeed "Analyze this code" --output-format json

For real-time streaming:

twkeed "Run tests and deploy" --output-format stream-json

Quick Examples

Start a new project

cd new-project/
twkeed
> Write me a Discord bot that answers questions using a FAQ.md file

Analyze existing code

cd my-project/
twkeed
> Give me a summary of all the changes in the last commit

Debug an issue

twkeed
> Help me debug why this function is returning undefined

📚 Documentation

Getting Started

• Quickstart Guide - Get up and running quickly
• Configuration - Settings and customization
• Keyboard Shortcuts - Productivity tips

Core Features

• Commands Reference - All slash commands (/help, /chat, etc)
• Custom Commands - Create your own reusable commands
• Context Files (TWKEED.md) - Provide persistent context
• Checkpointing - Save and resume conversations

Tools & Extensions

• Built-in Tools
  • File System Operations
  • Shell Commands
  • Web Fetch & Search
• MCP Server Integration - Extend with custom tools
• Custom Extensions - Build and share your own commands

Advanced Topics

• Headless Mode - Use Twkeed Code in automated workflows
• Sandboxing & Security - Safe execution environments
• Trusted Folders - Control execution policies by folder

Using MCP Servers

Configure MCP servers in ~/.twkeed/settings.json to extend Twkeed Code with custom tools:

> @github List my open pull requests
> @slack Send a summary of today's commits to #dev channel
> @database Run a query to find inactive users

🎨 Customization

Themes

Twkeed Code features a clean, minimalist white theme by default. You can customize the appearance through the settings.

Custom Commands

Create your own slash commands for frequently used operations:

/deploy     # Custom deployment command
/test       # Run your test suite
/build      # Build your project

🤝 Contributing

We welcome contributions! Twkeed Code is fully open source (Apache 2.0), and we encourage the community to:

• Report bugs and suggest features
• Improve documentation
• Submit code improvements
• Share your MCP servers and extensions

📖 Resources

• NPM Package - Package registry
• GitHub Repository - Source code
• Issues - Report bugs or request features

Keyboard Shortcuts

• Ctrl+C - Cancel current operation
• Ctrl+D - Exit Twkeed Code
• Ctrl+L - Clear screen
• Tab - Autocomplete commands
• ↑/↓ - Navigate command history

Uninstall

To uninstall Twkeed Code:

npm uninstall -g twkeed-code

📄 Legal

• License: Apache License 2.0
• Security: Report security issues to [email protected]