Start
Quickstart
Follow the four steps below to go from an empty terminal to a working agent session.
#Prerequisites
- Modern terminal: any maintained terminal emulator on macOS, Windows, or Linux.
- Provider key or local model: an API key for one provider, or a local model already running.
#Open a local project
Change into the project directory and launch the TUI with the invocation below.
bash
cd ~/projects/my-app && codey- Result: Codey opens the session scoped to that directory.
#Connect a provider
Authenticate from the terminal with the login invocation below.
bash
codey auth login- Alternative: type
/connectinside the TUI for the same flow. - Sync: a Codey Account syncs Pro status and keys between CLI and Desktop.
#Ask in Build or Plan
Press Tab to toggle between Build and Plan before sending your prompt.
- Build: Codey edits files directly.
- Plan: Codey proposes the change set first and waits for approval.
#Review diffs
Accept or reject each diff in the TUI before Codey touches the next file.
- Accepted: the edit is written to disk.
- Rejected: the file is left unchanged and Codey tries the next approach.