Documentation Navigation
Start

First project

Connect a provider and record project conventions so every session starts informed.

#Providers

#Log in

Authenticate a provider with the login invocation below.

bash
codey auth login
  • Result: the key is stored locally and used for subsequent sessions.

#List keys

Inspect configured providers with the list invocation below.

bash
codey auth list
  • Result: each provider prints with its identifier for later commands.

#Log out

Remove one provider with the logout invocation below, using the id from the list output.

bash
codey auth logout <id>
  • Result: the key is deleted from local storage.

#Project conventions

#Write AGENTS.md

Purpose: AGENTS.md tells Codey how your project builds, tests, and makes decisions. Keep the structure below in AGENTS.md at the repo root.

AGENTS.md
# Project

## Build

## Test

## Conventions
  • Headers first: one section per concern keeps generated edits small.
  • Generate it: run /init in the TUI to draft the file from your repo.

#Rewrite a prompt

Improve Prompt: one click rewrites your draft instruction into a precise prompt before it runs.

#Sync the account

Sign in once; the Codey Account syncs Pro status and keys between CLI and Desktop.

#See also