Intro

Get started with CoDev Code.

CoDev Code is an open source AI coding agent. It's available as a terminal-based interface, desktop app, or IDE extension.

Let's get started.

Install

CoDev Code is distributed as the codev-code package on npm. Install it globally with your Node.js package manager to get the codev command.

$ npm i -g codev-code

Alternatively, you can install it through CoDev Hub alongside the other AI agents:

npm i -g codev-ai
codevhub install

Windows

Recommended: Use WSL

For the best experience on Windows, we recommend using Windows Subsystem for Linux (WSL). It provides better performance and full compatibility with CoDev Code's features.

Initialize

You can now navigate to a project that you want to work on and run CoDev Code.

cd /path/to/project
codev

Sign in with SSO or configure a custom provider (if you already have an API key), and pick the model you want to use. Next, initialize CoDev Code for the project by running the following command.

/init

This will get CoDev Code to analyze your project and create an AGENTS.md file in the project root.

You should commit your project's AGENTS.md file to Git.

This helps CoDev Code understand the project structure and the coding patterns used.

Configure

With CoDev Code you can use any LLM provider by configuring their API keys.

Run the /connect command in the TUI and select your provider.
```
/connect
```
Paste your API key.
```
┌ API key
│
│
└ enter
```

You can use any of the supported providers. Learn more.

Usage

You are now ready to use CoDev Code to work on your project. Feel free to ask it anything!

If you are new to using an AI coding agent, here are some examples that might help.

Ask questions

You can ask CoDev Code to explain the codebase to you.

Use the @ key to fuzzy search for files in the project.

How is authentication handled in @packages/functions/src/api/index.ts

This is helpful if there's a part of the codebase that you didn't work on.

Add features

You can ask CoDev Code to add new features to your project. Though we first recommend asking it to create a plan.

Create a plan

CoDev Code has a Plan mode that disables its ability to make changes and instead suggest how it'll implement the feature.

Switch to it using the Tab key. You'll see an indicator for this in the lower right corner.
Switch to Plan mode
```
<TAB>
```
Now let's describe what we want it to do.
```
When a user deletes a note, we'd like to flag it as deleted in the database.
Then create a screen that shows all the recently deleted notes.
From this screen, the user can undelete a note or permanently delete it.
```
You want to give CoDev Code enough details to understand what you want. It helps to talk to it like you are talking to a junior developer on your team.

Give CoDev Code plenty of context and examples to help it understand what you want.
Iterate on the plan

Once it gives you a plan, you can give it feedback or add more details.
```
We'd like to design this new screen using a design I've used before.
[Image #1] Take a look at this image and use it as a reference.
```
Drag and drop images into the terminal to add them to the prompt.

CoDev Code can scan any images you give it and add them to the prompt. You can do this by dragging and dropping an image into the terminal.
Build the feature

Once you feel comfortable with the plan, switch back to Build mode by hitting the Tab key again.
```
<TAB>
```
And asking it to make the changes.
```
Sounds good! Go ahead and make the changes.
```

Make changes

For more straightforward changes, you can ask CoDev Code to directly build it without having to review the plan first.

We need to add authentication to the /settings route. Take a look at how this is
handled in the /notes route in @packages/functions/src/notes.ts and implement
the same logic in @packages/functions/src/settings.ts

You want to make sure you provide a good amount of detail so CoDev Code makes the right changes.

Undo changes

Let's say you ask CoDev Code to make some changes.

Can you refactor the function in @packages/functions/src/api/index.ts?

But you realize that it is not what you wanted. You can undo the changes using the /undo command.

/undo

CoDev Code will now revert the changes you made and show your original message again.

Can you refactor the function in @packages/functions/src/api/index.ts?

From here you can tweak the prompt and ask CoDev Code to try again.

You can run /undo multiple times to undo multiple changes.

Or you can redo the changes using the /redo command.

/redo

The conversations that you have with CoDev Code can be shared with your team.

/share

This will create a link to the current conversation and copy it to your clipboard.

Conversations are not shared by default.

Customize

And that's it! You are now a pro at using CoDev Code.

To make it your own, we recommend picking a theme, customizing the keybinds, configuring code formatters, creating custom commands, or playing around with the CoDev Code config.