GitHubDocsCocode Nut
Checking sign-in status
Documentation中文

Start here

Start with your first Cocode task

Quickstart

Quickstart

Guides

GUI desktop workspaceTUI terminal interface

Core concepts

Core conceptsPermissions and approvals

Models and teams

Cocode Nut model serviceTeams and organizations

Developers

API overview

Reference and help

CLI and shortcuts referenceTroubleshooting
Cocode Docs / Quickstart

Quickstart

This path takes you from installation to a verified code change.

Before you start

  • A supported macOS, Linux, or Windows device.
  • A Cocode account.
  • A code repository you can modify.
  • For TUI: Node.js 22.19.x or newer (Node 24+ is supported) and a real TTY.

1. Install Cocode

GUI is an Electron desktop app. Use the Cocode download page to reach the matching GitHub Release. TUI is installed from npm:

npm install --global @cocode-agency/tui
cocode doctor

Start the interface you need:

cocode              # TUI by default
cocode gui          # open GUI
cocode tui          # explicitly start TUI

2. Sign in and open a project

Complete browser sign-in on first run. GUI uses native authorization; TUI uses a device-code flow. If a device code expires or is denied, start login again.

cd your-project
cocode

Choose Cocode Nut or configure BYOK (a DeepSeek API key or OpenAI-compatible endpoint). BYOK requests do not consume Nut credits.

3. Give it a first task

Start with a bounded request:

Inspect this project, find a small issue in the login page, and propose a fix plan without changing files yet.

Cocode shows a plan first. File writes, commands, and network actions pause for confirmation when needed.

4. Review and confirm

Check the files, commands, impact, and verification plan before confirming. You can reject an action and add constraints.

5. Verify the result

Ask Cocode to run the repository's tests or checks, then review the change summary, command output, and unresolved issues.

Next steps

  • Read the GUI guide.
  • Read the TUI guide.
  • Understand permissions and approvals.
  • GUI/TUI session sharing requires the same DSH_HOME, profile, and Host scope.
Documentation is continuously updated.support@cocode.agency