Skip to content
Codive

Quick Start

Quick Start

Section titled “Quick Start”

This guide will get you up and running with Codive in under 5 minutes.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have:

Your First Conversation

Section titled “Your First Conversation”

  1. Navigate to your project

    Terminal window
    cd your-project

  2. Start Codive

    Terminal window
    codive

  3. Ask Codive something

    > What does this codebase do?

Codive will analyze your project and give you a summary of its structure and purpose.

Example Tasks

Section titled “Example Tasks”

Here are some common tasks you can ask Codive to help with:

Writing New Code

Section titled “Writing New Code”
> Create a function that validates email addresses

Codive will:

  1. Understand where to put the new code
  2. Match your project’s coding style
  3. Write the function with proper error handling
  4. Suggest tests if appropriate

Debugging

Section titled “Debugging”
> The login endpoint returns 500 error, help me debug it

Codive will:

  1. Find the relevant code
  2. Analyze potential issues
  3. Suggest fixes with explanations

Refactoring

Section titled “Refactoring”
> Refactor the UserService to use dependency injection

Codive will:

  1. Understand the current implementation
  2. Plan the refactoring steps
  3. Make changes across multiple files
  4. Ensure nothing breaks

Understanding Code

Section titled “Understanding Code”
> Explain how the authentication flow works

Codive will:

  1. Trace through the relevant code
  2. Explain each step
  3. Highlight important patterns

Interactive Mode

Section titled “Interactive Mode”

By default, Codive runs in interactive mode where you have a back-and-forth conversation:

$ codive


Welcome to Codive! I'm ready to help with your codebase.


> Add rate limiting to the API


I'll add rate limiting to your API. First, let me analyze your
current setup...


[Codive works on the task]


Done! I've added rate limiting middleware. Would you like me to:
1. Explain how it works
2. Add tests
3. Configure different limits per endpoint


>

One-Shot Mode

Section titled “One-Shot Mode”

For quick tasks, you can pass a prompt directly:

Terminal window
codive "add a .gitignore for Rust projects"

This runs Codive with your request and exits when complete.

Execution Modes

Section titled “Execution Modes”

Codive supports three execution modes:

Direct Mode

Default mode. Agent runs locally in your terminal.

Terminal window
codive

Server Mode

Start Codive as an HTTP server for remote access.

Terminal window
codive --serve

Client Mode

Connect to a remote Codive server.

Terminal window
codive --connect :3000

Best Practices

Section titled “Best Practices”

Common Commands

Section titled “Common Commands”
TaskExample
Write code"create a REST endpoint for users"
Fix bugs"debug why tests are failing"
Refactor"rename getUserById to findUser"
Explain"how does the caching layer work?"
Test"add unit tests for the auth module"
Document"add docstrings to the public API"

What’s Next?

Section titled “What’s Next?”

Basic Usage

Deep dive into all the ways you can use Codive.

Configuration

Learn how to configure Codive for your workflow.