Skip to content

getting-started.md

Latest commit

 

History

History
58 lines (39 loc) · 1010 Bytes

getting-started.md

File metadata and controls

58 lines (39 loc) · 1010 Bytes
Raw

Getting started with Codewith

Codewith is a local terminal coding agent. Install it, authenticate, and run it from the repository or project directory you want it to work in.

Install

bun install -g @hasna/codewith

You can also install it with npm:

npm install -g @hasna/codewith

Sign in

Run Codewith and select a login method:

codewith

You can also authenticate from the command line:

codewith login
codewith login --with-api-key

Codewith stores local state in ~/.codewith unless CODEWITH_HOME is set.

Start working

Run interactive Codewith in a project:

cd path/to/project
codewith

For one-off non-interactive work, use exec:

codewith exec "summarize the current changes"

For a code review pass, use review:

codewith review

Inside the TUI, type / to browse commands. Common starting points are /model, /profile, /config, /permissions, /review, /diff, and /resume.