Make yourself
at home.
Freecoda runs in your terminal, alongside the editor and tools you already use. Start with an existing Git repository on macOS, Linux, or Windows through WSL2.
Installation
The release install command will be:
npm install -g @freecoda/cliFrom a checkout of this repository, with Node.js 22+ and Bun installed:
bun install bun run build:cli node packages/cli/dist/index.js --help
Your first project
Build the CLI, then run it inside the project you want to work on. Review the repository trust prompt before continuing.
freecoda login cd ~/your-project freecoda
For a source build, substitute node /absolute/path/to/freecoda/packages/cli/dist/index.js for freecoda. Hosted sign-in requires a configured Freecoda server and beta invitation. The default hosted mode uses your free sponsored allowance; no API key is required.
A few useful commands
/plan add a settings page /review /usage /new /exit
Use freecoda --resume to reopen your latest local conversation. Use freecoda history clear to delete saved conversations for the current repository. Ctrl+C cancels the current request.
Advanced settings: optional API key
You do not need an API key for the free sponsored plan. Configure a direct provider only if you want to use your own model and account. Your provider bills you directly; this does not add sponsored credits or increase your Freecoda allowance.
Your CLI can connect directly to an OpenAI-compatible provider. Supply the provider’s HTTPS API base URL and exact model ID, and enter the key through the hidden prompt. You can also provide it through FREECODA_PROVIDER_KEY.
freecoda provider configure freecoda
Keys are saved locally with owner-only permissions when you choose to save them. Freecoda receives neither the key nor the model requests in this mode. Your provider’s pricing and data policies apply. Plain HTTP is supported only for loopback addresses, for local model servers.
To return to your free hosted allowance, run freecoda hostedand sign in with freecoda login if needed.
You stay in the loop
Freecoda asks before writing files or running shell commands. You may approve the current action or allow that action category for the session. Shell commands run as your user and can affect your machine; inspect them carefully.
Repository tools reject paths outside the workspace and respect ignored files. Shell approvals are a separate boundary: approved commands are not an operating-system sandbox. Your conversations stay locally; approved context is sent to the selected AI provider.