Skip to Content
Getting startedQuickstart

Quickstart

Prerequisites

  • .NET SDK 10.0 or later .
  • A project directory to work in.
  • Access to a supported model provider, or a local model server.

Install Codai

dotnet tool install --global Codai

Already installed? Update with dotnet tool update --global Codai.

Open your project

Run Codai from the directory containing your project so it can discover project guidance.

cd your-project

Connect a model

codai auth

Choose Use your own provider for a hosted provider or local server, or Continue with ChatGPT for an eligible account. Select a model and confirm before saving. Escape returns to the previous step.

Own-provider credentials are stored as plaintext in the selected configuration file. Keep that file private and out of version control. Remote credentials require HTTPS; loopback servers may use HTTP.

Start a session

codai code

Describe a concrete task. Review proposed file changes and commands before approving them. Use :help to list session commands and @src/Foo.cs to attach a file.

Explore before editing

Plan mode reads and searches without writing files or executing shell commands.

codai --mode plan "Explain this project and propose a small improvement"

Agent is the default mode. In an interactive session, use :mode to change modes. See Agent mode for shell permissions and approval controls.

Pick up where you left off

codai code --continue

Next steps

Last updated on