CLI Code Docs

Quick Start

Getting Started with CLI Code

Introduction

CLI Code is a Terminal-First, Multi-Model AI Coding Assistant Built for Developers who live in the CLI.

CLI Code Screenshot

The best tools are the ones that adapt to your workflow, not the other way around. - Linus Torvalds

What is CLI Code?

CLI Code is a terminal-first AI coding assistant that lets you bring your own AI model. It operates in two modes - Lite mode with add-ons for quick tasks, and Full mode with everything built-in for complex development. It integrates with VS Code and Cursor to propose changes directly in your editor, making your coding workflow seamless and efficient.

Key Features:

  • Bring Your Own Model: Support any AI model out there (Developer plan is free)
  • Two Operation Modes: Lite mode with add-ons or Full mode with everything built-in
  • Editor Integration: Works with VS Code/Cursor to propose changes directly in your editor
  • Context-Aware: Automatically detects your current file and selected code

Quick Setup

Follow these steps to get CLI Code up and running (detailed steps here)

  1. Login to Website

  2. Generate Token

    • Navigate to the Dashboard Page
    • Generate a new Refresh Token
    • Copy the token to your clipboard
  3. Install CLI Code

    npm i cli-code
  4. Configure CLI Code

    • Enter your Refresh Token when prompted
    • Select your preferred AI provider (OpenAI, Anthropic, Google, OpenRouter, etc.)
    • Get your API key from the selected provider's website
    • Enter your provider's API key
    • Choose from the available models for your selected provider
    • Configure any additional settings as needed (Optional)
  5. Open Codebase in Editor (VS Code preferred)

    • Open VS Code and let it initialize completely
    • Select your required repository/folder
  6. Start Using CLI Code

    • Open your Terminal
    • Run cli-code to start the assistant
    cli-code
    • Begin coding with AI assistance!

🚀 That's it! You're ready to start using CLI Code in your terminal.