Skip to main content

​
Prerequisites

Before you begin, you’ll need:

​
Step 1: Create Your Account

  1. Visit the Blocks Dashboard
  2. Create an account
  3. Complete the onboarding process
  4. You’ll automatically get a personal workspace

​
Step 2: Install Blocks

Choose the platforms where you want to use Blocks:
  1. From your Blocks Dashboard, go to Settings
  2. Navigate to Integrations
  3. Click “Connect” on the GitHub card
  4. Select the organization(s) and repositories then authorize the integration
You can add more repositories later from your workspace settings.
  1. From your Blocks Dashboard, go to Settings
  2. Navigate to Integrations
  3. Click “Connect” on the Slack card
  4. Select the workspace and authorize the integration
  5. Invite @blocks to channels where you want to use it
You’ll need admin permissions to install Slack apps in your workspace.
  1. From your Blocks Dashboard, go to Settings
  2. Navigate to Integrations
  3. Click “Connect” on the Linear card
  4. Authorize Blocks to access your Linear workspace
Blocks will be able to read and comment on issues in your Linear workspace.

​
Step 3: Configure Your Agent

You need to configure at least one coding agent to use Blocks. This will be completed when onboarding but you can update your configuration at any time:
  1. Go to your Blocks Dashboard
  2. Navigate to Dashboards → Agents
  3. Choose an agent and authentication method:
    • Claude Code:
      • API key: Enter your Anthropic API key
      • Or connect your Anthropic subscription (Claude Pro/Team)
      • Or configure AWS Bedrock credentials
    • Codex:
      • API key: Enter your OpenAI API key
      • Or connect your OpenAI subscription (ChatGPT Plus/Team)
    • OpenCode (experimental):
    • Sisyphus (experimental):
      • API keys: Enter your Anthropic API key and/or OpenAI API key
      • Multi-agent orchestration system (Main Conductor, Oracle, Backend Specialist)
      • Both API keys recommended for full capabilities
    • Gemini CLI (experimental): Enter your Google AI API key
    • Cursor CLI: Enter your Cursor API key (requires Cursor Pro/Team subscription)
Don’t know which agent to choose? Start with Claude Code—it’s excellent for most coding tasks. If you have a subscription (Claude Pro or ChatGPT Plus), you can connect that instead of using API keys. Learn more about choosing the right agent.
Experimental agents: OpenCode can be set as default, but Gemini CLI, Cursor CLI, and Sisyphus must be invoked using slash commands (/gemini, /cursor, /sisyphus).

​
Step 4: Set Your Default Agent

When multiple agents are configured, you can choose a default agent:
  1. In the Blocks Dashboard, go to Dashboard → Agents
  2. Select “Set as default agent” from the preferred agent’s dropdown menu
You can always override the default by using slash commands (/claude, /codex, /opencode, /gemini, /cursor, or /sisyphus) in your requests, assuming those agents are configured. Learn more about setting your default agent.
Only Claude Code, Codex, and OpenCode can be set as default agents. Gemini CLI, Cursor CLI, and Sisyphus must be invoked using slash commands.

​
Step 5: Make Your First Request

Now you’re ready to use Blocks! Here’s how to make your first request:
  1. Open any GitHub issue or pull request in your connected repositories
  2. Write a comment mentioning @blocks
  3. Describe what you need:
@blocks can you review this PR and check for any security issues?
  1. Blocks will respond with a 👀 emoji to acknowledge your request
  2. You’ll receive a dashboard link to track progress
  3. Blocks will comment back with results

​
Understanding Blocks Responses

When you mention @blocks, here’s what happens:
  1. 👀 Acknowledgment - Blocks immediately reacts to show it received your request
  2. Dashboard Link - You get a link to view detailed progress and logs
  3. Progress Updates - Blocks provides real-time updates on what it’s doing
  4. Results - Blocks shares the final outcome (code, explanations, PRs, etc.)
The dashboard link is only visible to you and your team members. Use it to:
  • Monitor progress in real-time
  • See detailed execution logs
  • Review all actions Blocks takes
  • Access generated code or analysis

​
Tips for Effective Requests

Make your requests clear and specific: Good Examples:
  • @blocks fix the login timeout issue mentioned in #123
  • @blocks review this PR for performance issues
  • @blocks create a REST API endpoint for user profiles
  • @blocks explain how the payment processing works
Less Effective:
  • @blocks help (too vague)
  • @blocks fix everything (too broad)
  • @blocks (no instruction)
The more context you provide, the better Blocks can help you.

​
Advanced Features

Once you’re comfortable with basic usage, explore these features:

Plan Mode

Collaborate on implementation plans before code changes

Custom Commands

Create reusable prompts for common tasks

Multi-Repo Support

Work across multiple repositories simultaneously

Agent Selection

Choose the best agent for each task

​
Need Help?

If you run into issues or have questions:

​
Next Steps

1

Explore Platform Integrations

Learn platform-specific tips for GitHub, Slack, and Linear
2

Understand Agents

Read about available agents and their strengths
3

Try Advanced Features

Experiment with Plan Mode and Commands
4

Join the Community

Connect with other users in our Slack community