Generacy Onboarding Guide
Get up and running in minutes with the one-command npx generacy launch flow —
create a project, run one command, and your AI-powered dev cluster is ready.
Prerequisites
Before you begin, make sure you have the following installed:
- Docker Desktop (or Docker Engine on Linux)
- Node.js 22+
(for
npx generacy) - Git
- A GitHub account
Step 1: Sign Up on Generacy
- Go to https://app.generacy.ai/
- Click "Get Started"
- Choose "Continue with GitHub" and authorize the Generacy app with your GitHub account
Step 2: Create a Project
- From the Generacy dashboard, click "New Project"
- Pick a name and select the GitHub repository you want to work on
- Follow the prompt to install the Generacy GitHub App on the organization or account that owns the repository
Step 3: Launch the Cluster
On your new project page, click "Launch locally" to generate a launch command. Copy the command and run it in any terminal:
npx generacy@latest launch --claim=<code> The CLI pulls the cluster image, starts Docker locally, and opens the in-browser bootstrap wizard. Claim codes expire 10 minutes after being generated — if yours expires, head back to the project page and click "Get a new command".
No manual API-key entry is needed: the wizard provisions Generacy and relay credentials for you.
💡 Tip
Step 4: Complete the Bootstrap Wizard
Once the cluster connects, the bootstrap wizard walks you through three quick steps:
- GitHub App install — grant the Generacy GitHub App access to the repositories you want the cluster to read and write.
- Claude authentication — sign in with Claude Max via
generacy claude-login, or paste an Anthropic API key. Either path works; Claude Max gives you the highest rate limits. - Peer-repo clone — if your project depends on sibling repositories
(declared in
.generacy/cluster.yaml), the wizard clones them into the cluster.
When the wizard reports Ready, the cluster is live and connected to the Generacy platform.
Step 5: Connect Your IDE
You have two ways to edit code in the cluster:
- In the browser — open the IDE tab on your project page to launch a code-server session in a new tab. Nothing else to install.
- Desktop VS Code via Remote Tunnel — open the Clusters tab, click "Connect with VS Code" , and complete the GitHub device-code flow. Your local VS Code then attaches to the cluster over the tunnel; you can also open the workspace from vscode.dev.
Step 6: Verify the Connection
- Go back to your project on https://app.generacy.ai/dashboard
- Open the Conversations tab
- You should be able to communicate with Claude about your project
- If the connection is working, you'll see activity from your cluster
Using Generacy for Development
Once your cluster is connected, Generacy works through GitHub issues and labels.
Creating Work Items
- Go to your project's GitHub repository
- Create a new Issue describing the feature or bug
- Assign the issue to yourself
- Apply one of the following labels to trigger a Generacy workflow:
| Label | Purpose |
|---|---|
process:speckit-feature | New feature development |
process:speckit-bug | Bug fix |
process:speckit-epic | Larger epic/initiative |
The Workflow
- Generacy picks up the issue — it detects the label and begins processing
- Clarifying questions — Generacy may ask clarifying questions as comments on the issue. Respond to these to refine the requirements
- Pull request — Once Generacy has enough context, it creates a PR with the implementation
- Review and merge — Review the PR, request changes if needed, and merge when satisfied
Quick Reference
| What | Where / Command |
|---|---|
| Generacy Dashboard | https://app.generacy.ai/dashboard |
| First-time local launch | npx generacy@latest launch --claim=<code> |
| Subsequent runs (from project dir) | npx generacy up |
| Cluster status | generacy status |
| Re-authenticate Claude | generacy claude-login |
| Cluster Config | .generacy/cluster.yaml |
Troubleshooting
Problem Solution Claim code expired
Claims expire 10 minutes after being generated. Go back to the project page
and click "Get a new command".
CLI complains about Node version
Node 22+ is required. Upgrade via nodejs.org
or your version manager (nvm install 22).
Claude not responding in conversations
Run generacy claude-login from your project directory to
re-authenticate.
Cluster fails to start
Ensure Docker Desktop (or Docker Engine) is running, then re-run the npx generacy launch command from your project page.