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:
  • Create your first spec or issue
  • View issues on the kanban board
  • Dispatch a workflow from a specification

​
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

Now that you have the web server running, explore these guides to learn more:

Agent Workflows Tutorial

See practical workflow examples for AI agents

Spec-Driven Development Tutorial

Follow a complete workflow from spec creation to implementation

Collaborative Data Analysis Tutorial

Build data analysis notebooks through iterative spec refinement

Creating Issues

Learn different methods for creating and organizing issues

Creating Specs

Write specifications that guide your AI agents

Web Interface Overview

Explore all features of the sudocode web interface