Skip to main content

Quick Start

1

Install sudocode

npm install -g sudocode
2

Initialize project

cd your-project
sudocode init
3

Start the web server

sudocode server
4

Open your browser and explore

Navigate to http://localhost:3000 and:
  • Browse specs in the sidebar
  • View issues on the kanban board
  • Create your first spec or issue
The web server currently doesn’t support a built-in spec-creation agent. For AI-assisted spec creation, you’ll need to set up the MCP Server with your AI agent.

Configuration

Custom Port

By default, the server starts on port 3000. To use a different port:
sudocode server --port 4000
Or set the SUDOCODE_PORT environment variable:
SUDOCODE_PORT=4000 sudocode server

File Watching

The server automatically watches .sudocode/ files for changes and updates the UI in real-time. To disable file watching:
SUDOCODE_WATCH=false sudocode server

Next Steps

1. Configure AI Agents with MCP Access

Set up the MCP agent to enable AI-assisted spec creation and issue management

2. Create your first spec

Learn how to write specs - currently via MCP server, with web editor coming soon

3. Create and manage issues

Learn how to manage issues in the web interface

4. Review in the web interface

Return to the web server at http://localhost:3000 to:
  • Review your specs with rendered markdown
  • View issues on the kanban board
  • See relationships and dependencies

5. Execute issues from the web view

Dispatch and monitor agent work from the web interface:
  • Select ready issues to assign to agents
  • Launch agents directly from the UI
  • Track progress in real-time
For more details, see the Web Server Overview.