Getting Started

Installation

SlyCode installs with one command. The scaffolder creates the folder SlyCode runs from, walks you through a short setup wizard, and seeds a tutorial board so the first thing you see is a working workflow.

Requirements

  • Node.js 20 or newer. Prebuilt native binaries ship for macOS, Windows, and Linux (arm64 and x64), so most installs need no build tools. On platforms without a prebuild, the installer warns and prints the right toolchain install command for your package manager. It never blocks the install.
  • At least one AI CLI installed and authenticated: Claude Code (claude), Codex CLI (codex), or Gemini CLI (gemini). SlyCode orchestrates these tools; it does not replace them.

Install

terminal
npx @slycode/create-slycode slycode

This creates the folder SlyCode runs from. The folder name is up to you; slycode is just the default. It is not one of your projects: your code stays wherever it already lives, and you add projects to SlyCode later.

The setup wizard confirms the install directory upfront, then asks about:

  • Timezone: auto-detected, used for scheduling automations.
  • Network binding: local-only (127.0.0.1) by default. Exposing the dashboard on your network is an explicit opt-in.
  • Ports: web, bridge, and messaging (defaults 7591, 7592, 7593).
  • Telegram and voice (optional): bot token, user id, and speech keys. You can add these later in .env.
  • System service (optional): register SlyCode with systemd, launchd, or Task Scheduler so it starts on boot.

Pass --yes to accept the defaults and skip the wizard: detected timezone, local-only binding, standard ports, no integrations, no service.

Start SlyCode

terminal
cd slycode
slycode start

Then open http://localhost:7591. On first launch the dashboard asks you to set a password; after that you land on the tutorial board, 18 cards that teach the workflow by doing it.

Verify the install

terminal
slycode doctor

Doctor runs nine checks: Node version, build tools, workspace, config, .env, port availability (it can tell SlyCode's own services apart from foreign processes), global CLIs, installed AI coding agents, and workspace structure.

Add your first project

From the dashboard, use Add Project and point SlyCode at a directory. The wizard scaffolds the essential skills and project files into it and creates a starter card that matches what it finds:

  • Existing code: an "Onboard existing project" card. The AI scans read-only first, checks git state, then proposes cards and docs.
  • Empty directory: a "Set up new project" card that walks through purpose, stack, and first features conversationally.

Everyday commands

CommandWhat it does
slycode startStarts the SlyCode services. Delegates to the system service manager if services are installed.
slycode stopStops all services gracefully.
slycode restartRestarts services, aware of how they were started (service manager or background process).
slycode updateInstalls the latest release, refreshes skills, actions, and provider configs, reinstalls services, and verifies everything comes back up.
slycode syncRefreshes skills, actions, and provider templates in place without a package update.
slycode doctorPost-install diagnostic. Run this first when something looks wrong.
slycode reset-passwordClears the dashboard password and signs out all sessions. Local-only, so you can never be permanently locked out.

Next steps