1. Documentation
  2. Getting Started

Prerequisites

Before you begin, make sure you have:

Installation

Choose your preferred installation method:

  • npm

  • curl

npm install -g chad-code

Or to run without global installation:

npx chad-code

Quick Start

1

Run Chadcode

Go to your project directory and run:

chad-code
2

Configure your API key

Set your ChadCode API key in the interactive terminal

/connect

Then paste in your API key

Basic Usage

Here are some common commands to get you started:

One shot query example

chad-code run "explain the main function in app.js"

Generate documentation

chad-code docs generate

YOLO mode (approve all actions)

chad-code -y "refactor this code to use async/await"