-
Notifications
You must be signed in to change notification settings - Fork 4.1k
docs: Add documentation for running agents locally #9507
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Update agents overview documentation - Add new guide for running agents locally - Update docs.json configuration Generated with [Continue](https://continue.dev) Co-Authored-By: Continue <[email protected]>
Learn moreAll Green is an AI agent that automatically: ✅ Addresses code review comments ✅ Fixes failing CI checks ✅ Resolves merge conflicts |
2 similar comments
Learn moreAll Green is an AI agent that automatically: ✅ Addresses code review comments ✅ Fixes failing CI checks ✅ Resolves merge conflicts |
Learn moreAll Green is an AI agent that automatically: ✅ Addresses code review comments ✅ Fixes failing CI checks ✅ Resolves merge conflicts |
Removed redundant text from title to potentially fix Mintlify build issue Generated with [Continue](https://continue.dev) Co-Authored-By: Continue <[email protected]>
Fixed incorrect path from /hub/agents/overview to /agents/overview for the pre-configured-agents anchor link Generated with [Continue](https://continue.dev) Co-Authored-By: Continue <[email protected]>
- Remove draft_pr.md (no longer needed) - Add discussion_response.md Generated with [Continue](https://continue.dev) Co-Authored-By: Continue <[email protected]>
…inue into bdougie/run-agents-docs
Use 4 backticks for outer code fence to prevent nested code blocks from breaking MDX parser. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Replace inline workflow with Continue's reusable workflow which handles agent discovery, parallel execution, and check reporting. GH_TOKEN is now automatically provided for agents using the gh CLI. Co-Authored-By: Claude Opus 4.5 <[email protected]>
|
Waiting on #9497 |
docs/guides/run-agents-locally.mdx
Outdated
| </Card> | ||
|
|
||
| <Card title="Use Descriptive Names" icon="tag"> | ||
| Name agent files clearly: `conventional-title.md`, `security-scan.md`, `deploy-checklist.md`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not certain but I think name: in the agent file will take precedence and is potentially preferred. Maybe worth noting they can both be used (I think)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated - clarified name field is displayed, filenames for organization
docs/guides/run-agents-locally.mdx
Outdated
| - Simplify the prompt and add more specific instructions | ||
| - Check if the agent has access to required tools | ||
| - Enable verbose logging: `cn --verbose --agent .continue/agents/my-agent.md` | ||
| - Review logs at `~/.continue/logs/cn.log` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(debateably) mac-only file path
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made platform-agnostic
| <Card title="What You'll Build" icon="folder-open"> | ||
| A local agent system that: | ||
| - Keeps agent definitions version-controlled alongside your code | ||
| - Runs agents with Continue CLI for local development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
potential confusion, the user would run the agent locally not the system
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed section
| - Keeps agent definitions version-controlled alongside your code | ||
| - Runs agents with Continue CLI for local development | ||
| - Automates agent execution on pull requests via GitHub Actions | ||
| - Applies consistent workflows across your team |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this bullet point feels unnecessary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed section
docs/guides/run-agents-locally.mdx
Outdated
| - Applies consistent workflows across your team | ||
| </Card> | ||
|
|
||
| ## Why Local Agents? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential confusion: "Local agents"; it's in github and that's where the value is. Maybe "codebase" agents or similar?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The alternative is Cloud agents. Using the word local is to distinguish between what's in mission control
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The distinction makes sense, I think the word "local" might be a point of confusion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added clarifying note at top distinguishing local (repo) vs cloud (Mission Control)
docs/guides/run-agents-locally.mdx
Outdated
| --agent .continue/agents/analysis-only.md | ||
|
|
||
| # Always ask before running commands | ||
| cn --ask "Bash(*)" --agent .continue/agents/my-agent.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--ask will not work in CI/CD since user can't intervene, so maybe best if we don't mention it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
docs/guides/run-agents-locally.mdx
Outdated
| Before enabling fully automated agents: | ||
|
|
||
| 1. **Test locally first** - Run agents with `cn` to verify behavior | ||
| 2. **Use `--ask` mode** - Require approval for sensitive operations during testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed
docs/guides/run-agents-locally.mdx
Outdated
|
|
||
| 1. **Test locally first** - Run agents with `cn` to verify behavior | ||
| 2. **Use `--ask` mode** - Require approval for sensitive operations during testing | ||
| 3. **Review CI logs** - Check what commands agents execute in your workflows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
unclear if the commands the agents execute will show up in logs like this
docs/guides/run-agents-locally.mdx
Outdated
|
|
||
| Continue provides a [reusable workflow](https://github.com/continuedev/continue/blob/main/.github/workflows/continue-agents.yml) that handles agent discovery, parallel execution, and GitHub Check reporting. | ||
|
|
||
| ### Using the Reusable Workflow (Recommended) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Says "Recommended" but it's the only proceeding option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed label
| ```bash | ||
| # Use your GitHub CLI token | ||
| export GH_TOKEN=$(gh auth token) | ||
| cn --agent .continue/agents/my-agent.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
must set ANTHROPIC_API_KEY locally as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added to Environment Variables section
- Add clarifying note distinguishing local vs cloud agents - Remove redundant CardGroup section - Fix API key naming to ANTHROPIC_API_KEY - Clarify GitHub CLI pre-installed on runners - Remove unnecessary tools: built_in from examples - Rename "Rules" to "Guidelines" to avoid frontmatter confusion - Flip headless/TUI order (headless is typical) - Simplify frontmatter table, link to reference - Move GitHub Actions section before Security - Remove --ask from CI guidance (requires user intervention) - Fix mac-only log path - Add ANTHROPIC_API_KEY to local env vars section - Clarify name field vs filename in best practices Co-Authored-By: Claude Opus 4.5 <[email protected]>

Description
Waiting on #9497
This PR adds documentation for running Continue agents locally, including:
AI Code Review
@continue-reviewChecklist
Screen recording or screenshot
[TODO: Add screen recording or screenshot if applicable - see this PR as a good example]
Tests
Documentation changes - no tests required.
Continue Tasks
Powered by Continue
Summary by cubic
Adds documentation for running Continue agents locally with version-controlled agent files and GitHub Actions integration. Updates the Agents overview and navigation to make local agents easy to find and use, and fixes broken links in the Agents pages.
New Features
Bug Fixes
Written for commit 9a701e2. Summary will update on new commits.