CLI Reference

Crosslink has no single installed CLI binary. The canonical entrypoints are the workspace scripts in the monorepo, with a few root aliases for convenience.

Services

Start signaling and relay

npm run stack

Starts both services on localhost.

Development

Build all packages

npm run build

Run tests

npm test

Examples

Run the echo host

cd examples/echo-host
npm run dev

Run the notes host

cd examples/notes-host
npm run dev

Run the todo host

cd examples/todo-host
npm run dev

Run the Electron chat example

npm run dev -w @crosslink/example-electron-chat

Run a workspace in remote mode

The same workspaces can be started with remote access already enabled — see Remote Access:

node examples/echo-host/src/cli.ts --remote
node examples/todo-host/src/cli.ts --remote
CROSSLINK_NETWORK_MODE=remote npm run dev -w @crosslink/demo-chat

Check remote-access readiness

npm run check:remote

Environment variables

Variable	Description	Default
`PORT`	Signaling/relay service port	`8081` / `8082`
`HOST`	Signaling/relay bind address	`0.0.0.0`
`CROSSLINK_SIGNALING_URL`	Signaling URL (host SDK)	(auto-discovered)
`CROSSLINK_RELAY_URL`	Relay URL (host SDK)	(auto-discovered)
`CROSSLINK_REDIS_URL`	Shared signaling backplane	(in-memory)
`CROSSLINK_REGION`	Signaling/relay region label	(none)
`CROSSLINK_SECRET_KEY`	Passphrase for encrypted storage	(none)
`CROSSLINK_DATA_DIR`	Where the dev-token/stack config lives (`@crosslink/dev-tokens`). A host’s own `storageDir` is a config field, not this.	`.crosslink-data`

Troubleshooting

Port already in use

# Find what's using the port
lsof -i :8081

# Kill the process
kill <PID>

Connection refused

# Check if services are running
curl http://127.0.0.1:8081/health
curl http://127.0.0.1:8082/health

Module not found

# Ensure dependencies are installed
npm install

# Ensure you're using ESM
# package.json should have: "type": "module"

GET STARTED

BUILD

CONCEPTS

CLIENT

CONNECTIONS

SECURITY

GUIDES

REFERENCE

RESOURCES

Services

Start signaling and relay

Development

Build all packages

Run tests

Examples

Run the echo host

Run the notes host

Run the todo host

Run the Electron chat example

Run a workspace in remote mode

Check remote-access readiness

Environment variables

Troubleshooting

Port already in use

Connection refused

Module not found

​Services

​Start signaling and relay

​Development

​Build all packages

​Run tests

​Examples

​Run the echo host

​Run the notes host

​Run the todo host

​Run the Electron chat example

​Run a workspace in remote mode

​Check remote-access readiness

​Environment variables

​Troubleshooting

​Port already in use

​Connection refused

​Module not found

Services

Start signaling and relay

Development

Build all packages

Run tests

Examples

Run the echo host

Run the notes host

Run the todo host

Run the Electron chat example

Run a workspace in remote mode

Check remote-access readiness

Environment variables

Troubleshooting

Port already in use

Connection refused

Module not found