Gnoll Docs Back to Dashboard
Quick Start
Getting Started
Integrations
Issue Compaction

Quick Start with Claude Code

Get up and running with Gnoll using the Claude Code plugin in under 5 minutes.

Why Claude Code? Gnoll is built for AI-assisted workflows. The Claude Code plugin lets you create, manage, and close issues without leaving your terminal. Claude understands your codebase and can create well-scoped issues for you.

1. Create an Account & Project

1
Sign up and create a project

Click Register on the home page. Enter a username and password — no email confirmation required.

Then go to Projects and create your first project. Select it from the project dropdown in the sidebar.

2. Generate an API Key

2
Get your credentials

Go to API Keys and generate a new key. Copy it — you'll need it in the next step.

3. Install the Claude Plugin

3
Add the Gnoll plugin to Claude Code

First, add the marketplace (one time):

claude plugin marketplace add aml630/gnoll-plugin

Then install the plugin:

claude plugin install gnoll

Finally, initialize it in your project with your API key:

gnoll init --key YOUR_API_KEY

This connects Claude to your Gnoll instance and creates a .gnoll/config file in your project root. Commit it to your repo so all agents pick it up automatically.

4. Create Issues with Claude

4
Let Claude create your issues

Just tell Claude what you need to do in natural language:

"Create a task to add user avatar uploads with priority 2"

Or use the slash command directly:

/create Add user avatar uploads task 2

Claude will create the issue with the right type, priority, and description. You can also ask Claude to break down larger work into multiple issues:

"Break down the authentication feature into tasks"

5. Work Through Your Issues

5
Claim, work, close

Use these commands in Claude Code to manage your workflow:

  • /list — See your open issues
  • /ready — See issues with no unresolved blockers
  • /claim <id> — Assign an issue to yourself
  • /show <id> — View issue details
  • /close <id> — Close an issue when done

Claude keeps track of your project context, so you can also ask things like "what should I work on next?" or "show me what's blocked."

6. Add Dependencies

6
Define what blocks what

Tell Claude about dependencies between issues:

/dep <issue-id> --on <blocker-id>

Or describe it naturally: "Make the API task depend on the database schema task." Closing a blocker automatically unblocks everything waiting on it.

Next Steps

Now that you're set up, explore these features:

Updating the Plugin

The Gnoll plugin receives updates with new features and bug fixes. To update to the latest version:

claude plugin install gnoll

This pulls the latest version from the marketplace. You can check which version you're running with:

gnoll version
Tip: Use /prime in Claude Code to refresh Claude's context if things get stale.