Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/agent0ai/space-agent/llms.txt

Use this file to discover all available pages before exploring further.

Space Agent is a Node.js server with a browser-first frontend — getting it running locally takes just a few commands. You will clone the repository, install dependencies, create an admin user, and start the server. From that point your browser becomes the full agent workspace, ready to build Spaces, Widgets, and Skills alongside you.

​
Prerequisites

Before you begin, make sure you have Node.js 20 or later installed. Space Agent requires Node.js >=20 and uses ES modules throughout the codebase. 
node --version
# Should print v20.x.x or higher
If you prefer not to use the terminal at all, the desktop app bundles everything into a single downloadable application — no Node.js installation or command line required.

​
Start the Server

1
Clone the repository and install dependencies
2
Clone Space Agent from GitHub and run npm install to fetch the server’s dependencies.
3
Clone and install
git clone https://github.com/agent0ai/space-agent.git
cd space-agent
npm install
4
The install step is fast — the production dependency tree is intentionally small. You will see a node_modules/ directory appear once it completes.
5
Create an admin user
6
Before starting the server for the first time you need at least one user. The node space user create command writes directly to the filesystem and can assign the user to one or more groups in the same call.
7
Create admin user
node space user create admin \
  --password "change-me-now" \
  --full-name "Admin" \
  --groups _admin
8
Replace "change-me-now" with a strong password before exposing the server to any network. The _admin group grants access to the admin shell and all system management commands.
9
The --groups flag accepts a comma-separated list. Adding _admin here creates the predefined admin group and assigns the new user to it in one step. User data is written to the logical L2 layer and group membership to L1.
10
Start the server
11
Run node space serve to start the HTTP runtime. The server prints its version and the URL it is listening on:
12
Start the server
node space serve
Expected output
space server version 0.36.0
space server listening at http://localhost:3000
13
The default port is 3000. You can override it at launch time with PORT=<number>:
14
Custom port
node space serve PORT=8080
15
Open Space Agent in your browser
16
Navigate to http://localhost:3000 in any modern browser. You will see the login page. Sign in with the admin username and the password you set in step 2.
17
After signing in you land in the main agent workspace — your first Space. The floating agent overlay is ready to take requests, build widgets, or extend the system with new Skills.

​
Alternative: Single-User Mode

If you are running Space Agent just for yourself on a trusted machine, you can skip user creation entirely by enabling SINGLE_USER_APP mode. The server runs as an always-authenticated implicit user named user with virtual _admin access — no login screen appears. 
node space serve SINGLE_USER_APP=true
Use node space set SINGLE_USER_APP=true to persist this setting to .env so you do not need to pass it on every start.

​
Development Mode

If you are making changes to the server or CLI source, npm run dev runs the same server with automatic restart on file changes in space, commands/, and server/: 
npm run dev
The watcher keeps the parent process alive between restarts so a single file save is enough to pick up changes. A checked-in VS Code launch entry named Dev Server (npm run dev) starts the same watcher and auto-attaches to the spawned child process so breakpoints in server/ code still bind after each auto-restart.
npm run dev is a source-checkout development tool, not a node space CLI command. It is not intended for production use.

​
Quick-Reference: All Startup Variants

node space serve

​
What to Do Next

Deployment

Learn about desktop app, personal server, and production team modes — including zero-downtime supervision and writable state management.

CLI Reference

Browse all runtime parameters — HOST, PORT, WORKERS, CUSTOMWARE_PATH, and more — with types, defaults, and allowed values.

Build docs developers (and LLMs) love

Get started for freeTalk to us