@codienters/sheikh-cli
v2.0.1
Published
AI agents your unfair advantage - powerful AI capabilities in your terminal
Downloads
7
Maintainers
Readme
Sheikh-CLI: AI Agents Your Unfair Advantage
Powerful AI capabilities in your terminal. Build agents and workflows with our API. Turn hours-long workflows into a single command.
🚀 What is Sheikh-CLI?
Sheikh-CLI is an agentic coding tool that lives in your terminal and helps you turn ideas into code faster than ever before. It's your unfair advantage in AI-powered development.
✨ Key Features
- 🤖 Agentic Search: Understand your entire codebase without manual context selection
- 🔄 Multi-File Coordination: Make coordinated changes across multiple files
- 👁️ Visual Diffs: See visual diffs and approve changes before they're applied
- ⚙️ Workflow Generation: Turn natural language descriptions into executable workflows
- 🛡️ Production-Grade: Never modifies files without explicit approval
- 🔧 IDE Integration: Works with VS Code, JetBrains, and any terminal
- 🌐 Multi-Provider: Supports Anthropic, OpenAI, AWS Bedrock, Google Vertex AI, and more
🎯 Why Sheikh-CLI?
Your Codebase, Evolving at Thought Speed
- Search million-line codebases instantly with agentic search
- Turn hours-long workflows into a single command
- Your tools. Your workflow. Your codebase.
- Researchers and engineers use—right to your terminal
Powerful Intelligence
- Uses agentic search to understand your entire codebase
- Makes coordinated changes across multiple files
- Optimized specifically for code understanding
- Lives right inside your terminal—no context switching
Integration Excellence
- Integrates with VS Code / JetBrains IDEs
- Uses your test suites and build systems
- Never modifies your files without explicit approval
- Adapts to your coding standards and patterns
- Configurable: Build on the SDK or run on GitHub Actions
📦 Installation
Quick Install
npm install -g @codienters/sheikh-cliFrom Source
git clone https://github.com/codienters/sheikh-cli.git
cd sheikh-cli
npm install
npm link⚡ Quick Start
1. Set Up Your API Key
# Anthropic (Recommended)
export API_KEY="your-anthropic-api-key"
# Or OpenAI
export OPENAI_API_KEY="your-openai-api-key"
# Or AWS Bedrock
export AWS_ACCESS_KEY_ID="your-aws-access-key"
export AWS_SECRET_ACCESS_KEY="your-aws-secret-key"2. Initialize Configuration
sheikh config --init3. Start Agentic Chat
sheikh chat --agentic🎮 Usage Examples
Agentic Search
# Search your entire codebase
sheikh search "authentication middleware"
# Search with filters
sheikh search "API endpoints" --type js --limit 5Codebase Analysis
# Analyze your entire codebase
sheikh analyze
# Generate detailed report
sheikh analyze --output report.md --format markdownWorkflow Generation
# Generate workflow from natural language
sheikh workflow "deploy to production with tests"
# Execute workflow immediately
sheikh workflow "create new feature branch" --execute
# Preview workflow without executing
sheikh workflow "refactor authentication" --dry-runInteractive Chat
# Start agentic chat session
sheikh chat --agentic --visual-diff --coordinate
# Use slash commands in chat
/agents # List available agents
/search <query> # Search codebase
/analyze # Analyze codebase
/workflow <desc> # Generate workflow🤖 Available Agents
Core Agents
| Agent | Purpose | Capabilities | |-------|---------|-------------| | Codebase Analyzer | Understand and index your codebase | Search, analyze, index, understand | | Multi-File Editor | Coordinate changes across files | Edit, create, modify, coordinate | | Test Coordinator | Manage testing workflows | Test, validate, coordinate, report | | Git Workflow | Handle Git operations | Commit, push, branch, merge, PR | | Dependency Manager | Manage project dependencies | Install, update, audit, resolve | | Security Auditor | Audit code for security issues | Audit, scan, vulnerability, security | | Performance Optimizer | Optimize code performance | Optimize, profile, benchmark, improve | | Documentation Generator | Generate documentation | Generate, document, API, README |
Custom Agents
Create your own agents for specific tasks:
# Create a custom agent
sheikh agents --create my-agent
# List all agents
sheikh agents --list
# Show agent status
sheikh agents --status🔧 Configuration
Environment Variables
# Anthropic
API_KEY="your-anthropic-api-key"
ANTHROPIC_API_KEY="your-anthropic-api-key"
# OpenAI
OPENAI_API_KEY="your-openai-api-key"
OPENAI_NATIVE_API_KEY="your-openai-native-api-key"
# AWS Bedrock
AWS_ACCESS_KEY_ID="your-aws-access-key"
AWS_SECRET_ACCESS_KEY="your-aws-secret-key"
AWS_SESSION_TOKEN="your-aws-session-token"
AWS_DEFAULT_REGION="us-east-1"
# Google Vertex AI
GOOGLE_APPLICATION_CREDENTIALS="path/to/credentials.json"
GEMINI_API_KEY="your-gemini-api-key"
# Other Providers
OPEN_ROUTER_API_KEY="your-openrouter-api-key"
CLINE_API_KEY="your-cline-api-key"
DEEP_SEEK_API_KEY="your-deepseek-api-key"
# ... and many moreConfiguration File
{
"globalState": {
"apiProvider": "anthropic",
"apiModelId": "claude-3-5-sonnet-20241022",
"agenticEnabled": true,
"autoApprovalSettings": {
"enabled": true,
"actions": {
"readFiles": true,
"editFiles": false,
"executeSafeCommands": true,
"useMcp": false
},
"maxRequests": 20
}
},
"settings": {
"cline.enableCheckpoints": false,
"agentic.visualDiff": true,
"agentic.coordinateChanges": true,
"agentic.autoApprove": false
}
}🛠️ Advanced Features
Agentic Search
Sheikh-CLI uses advanced semantic search to understand your entire codebase:
# Search by functionality
sheikh search "user authentication"
# Search by file type
sheikh search "database models" --type py
# Search with context
sheikh search "error handling middleware"Multi-File Coordination
Make coordinated changes across multiple files:
# Refactor across multiple files
sheikh chat "Refactor the authentication system to use JWT tokens"
# The system will:
# 1. Analyze all related files
# 2. Plan coordinated changes
# 3. Show visual diffs
# 4. Apply changes only after approvalWorkflow Generation
Generate complex workflows from natural language:
# Generate deployment workflow
sheikh workflow "Deploy to staging, run tests, and create PR"
# Generate development workflow
sheikh workflow "Create feature branch, implement feature, write tests, create PR"Visual Diff System
See exactly what changes will be made before they're applied:
📊 Visual Diff Preview:
─────────────────────────────────────────────────
📁 src/auth/middleware.js
Type: modify
Lines: 10-15
+ Added JWT verification
- Removed session-based auth
─
📁 src/auth/routes.js
Type: create
Lines: 1-20
+ Added JWT routes
─
─────────────────────────────────────────────────
❓ Do you approve these changes? (y/n)🔌 IDE Integration
VS Code
Install the Sheikh-CLI extension for enhanced VS Code integration:
# Install VS Code extension
code --install-extension sheikh-cli.vscode-extensionJetBrains
Enhanced capabilities in JetBrains IDEs:
# Install JetBrains plugin
sheikh install --ide jetbrainsTerminal Integration
Works in any terminal with enhanced capabilities:
# Enable terminal integration
sheikh config --enable-terminal-integration📚 Documentation
- CLAUDE.md - Comprehensive development guide
- AGENTS.md - Agent system documentation
- API Reference - Complete API documentation
- Examples - Usage examples and tutorials
- Contributing - How to contribute
🧪 Testing
# Run all tests
npm test
# Run tests in watch mode
npm run test:watch
# Run tests with coverage
npm run test:coverage
# Run specific test suite
npm run test:unit
npm run test:integration
npm run test:e2e🚀 Development
Setup
git clone https://github.com/codienters/sheikh-cli.git
cd sheikh-cli
npm installDevelopment Mode
# Start in development mode
npm run dev
# Run with debug logging
DEBUG=sheikh:* npm run devCode Quality
# Run linter
npm run lint
# Fix linting issues
npm run lint:fix
# Format code
npm run format🤝 Contributing
We welcome contributions! Please see our Contributing Guide for details.
Development Workflow
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests for new functionality
- Run the test suite
- Submit a pull request
Code Standards
- Follow ESLint configuration
- Write comprehensive tests
- Document public APIs
- Follow semantic versioning
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🆘 Support
Documentation
- README.md: This file
- CLAUDE.md: Development guide
- AGENTS.md: Agent documentation
- API Documentation: Inline code documentation
Community
- GitHub Issues: Bug reports and feature requests
- Discussions: Community discussions and questions
- Wiki: Additional documentation and guides
Contact
- Maintainer: Sheikh-CLI Team
- Email: [email protected]
- GitHub: https://github.com/codienters/sheikh-cli
🙏 Acknowledgments
- Built with ❤️ by the Sheikh-CLI team
- Powered by advanced AI models from Anthropic, OpenAI, AWS, and Google
- Inspired by the need for better developer tools
Ready to give yourself an unfair advantage? Install Sheikh-CLI today and experience the future of AI-powered development.
npm install -g @codienters/sheikh-cli
sheikh chat --agentic