Ensure you have Node.js v18 or higher installed.
Option 1: Run without installing (Recommended for first-time users)
npx @enfiy/enfiy-code
Option 2: Install globally (Recommended for regular use)
npm install -g @enfiy/enfiy-code
enfiy
On first run, you'll be guided through selecting a theme, AI provider, and authentication method. Your settings persist automatically.
Enfiy Code is a command-line AI workflow tool that integrates with your development environment. It understands your code and helps you work more efficiently, whether you're working locally or in the cloud.
- Query and edit large codebases using advanced AI models with extended context support
- Generate applications from PDFs or sketches using multimodal AI
- Automate tasks like querying pull requests or handling complex rebases
- Connect external tools through MCP (Model Context Protocol)
- Support for multiple AI providers - both cloud and local
Provider | Description |
---|---|
![]() |
Anthropic Claude Industry-leading AI for coding tasks |
![]() |
OpenAI GPT Popular and versatile language models |
![]() |
Google Gemini Multimodal AI with strong reasoning capabilities |
![]() |
Mistral AI Open-source focused AI models |
![]() |
OpenRouter Unified access to many AI models |
Provider | Description |
---|---|
![]() |
Ollama Run models locally with full privacy |
- Node.js v18 or higher
- npm or yarn package manager
- Git
- Clone the repository
git clone https://github.com/enfiy/enfiy-code.git
cd enfiy-code
- Install dependencies
npm install
This will install all required packages listed in package.json
.
- Build the project
npm run build
This compiles TypeScript and prepares the application for execution.
- Start the development version
npm start
This launches Enfiy Code in development mode.
npm run start
- Start in development modenpm run debug
- Start with debugging enablednpm run build
- Build for productionnpm run test
- Run test suitenpm run lint
- Check code style and qualitynpm run format
- Format code automaticallynpm run typecheck
- TypeScript type checkingnpm run preflight
- Complete CI pipeline check
For production use, you may want to set up custom OAuth applications:
# Set custom Google OAuth credentials (optional)
export ENFIY_GOOGLE_OAUTH_CLIENT_ID="your-client-id.apps.googleusercontent.com"
export ENFIY_GOOGLE_OAUTH_CLIENT_SECRET="your-client-secret"
To create your own Google OAuth client:
- Visit Google Cloud Console
- Create new OAuth 2.0 Client ID
- Select "Desktop application"
- Name it "Enfiy Code"
- Use the credentials in environment variables above
# Set custom HuggingFace OAuth client ID (optional)
export HF_CLIENT_ID="your-huggingface-app-id"
Note: By default, Enfiy Code uses temporary OAuth clients for compatibility. Custom OAuth setup ensures proper branding in consent screens.
Enfiy Code supports various command-line options to customize your experience:
-m, --model <model>
- Specify AI model to use-p, --prompt <text>
- Start with an initial prompt
-y, --auto
- Automatically approve all AI actions-a, --all-files
- Include all project files in context-c, --checkpointing
- Enable file edit checkpointing
-d, --debug
- Enable debug mode with verbose logging--show-memory-usage
- Display memory usage in status bar
-s, --sandbox
- Run in isolated sandbox environment--sandbox-image <image>
- Use custom sandbox container image
# Start interactive mode
enfiy
# Use specific model
enfiy -m "gpt-4"
# Start with a prompt
enfiy -p "Review my code for security issues"
# Auto-approve all actions
enfiy --auto
# Enable debug mode
enfiy --debug
Once Enfiy Code is running, use these commands to interact with the AI:
/provider
- Select AI provider and model/mcp
- Connect to MCP servers for enhanced capabilities/tool
- Access specialized tools and integrations/help
- Show available commands and usage information/bug
- Report bugs or issues to the development team- Code with confidence, create without limits, command with ease
# Start Enfiy Code
enfiy
# Ask questions about your code
> What does this function do?
> How can I optimize this database query?
# Request code changes
> Add error handling to the user authentication
> Refactor this component to use React hooks
# Start a new project
cd my-project/
enfiy
> Create a React app with TypeScript and authentication
> Add a responsive navigation component
> Set up Jest testing framework
# Analyze existing codebase
enfiy
> Review this codebase for security vulnerabilities
> Identify performance bottlenecks
> Suggest architectural improvements
# Automate development workflows
enfiy
> Write comprehensive tests for the API endpoints
> Generate documentation for these functions
> Create deployment scripts for production
- Quick Start Guide – Get up and running in minutes
- Installation – Detailed installation instructions
- First Steps – Essential commands and workflows
- API Configuration – Set up AI provider authentication
- All Guides – Complete guide collection
- MCP Integration – Connect external tools and services
- Checkpointing – Save and restore conversation sessions
- API Documentation – Technical reference
- CLI Commands – Complete command reference
- Tools Reference – Built-in tools and capabilities
- Development Guide – Contributing and development setup
- Architecture – System design and components
- Extensions – Creating custom extensions
- Security Overview – Security policies and best practices
- Privacy Policy – Data handling and privacy rights
- Telemetry – Data collection and opt-out options
enfiy-code/
├── packages/ # Monorepo packages
│ ├── cli/ # CLI application
│ └── core/ # Core library
├── docs/ # Documentation
├── scripts/ # Build and development scripts
├── integration-tests/ # End-to-end tests
├── bundle/ # Built CLI bundle
├── build-artifacts/ # Build analysis files
└── tools/ # Development utilities
We welcome contributions to Enfiy Code! Please see our contributing guidelines for more information on how to get started.
Enfiy Code is licensed under the Apache 2.0 License.
Thank you for using Enfiy Code! 🧡
Built with care by the Enfiy Community