Skip to content

Conversation

@D-K-P
Copy link
Member

@D-K-P D-K-P commented Feb 10, 2026

  • Adds a new example project guide for running Cursor's headless CLI agent as a Trigger.dev task with live Realtime Streams output
  • New doc page at guides/example-projects/cursor-background-agent.mdx
  • Added to sidebar nav and example projects table

Open with Devin

@changeset-bot
Copy link

changeset-bot bot commented Feb 10, 2026

⚠️ No Changeset found

Latest commit: 33865a4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2026

Walkthrough

This pull request adds documentation and navigation entries for a new example project "cursor-background-agent". It creates docs/guides/example-projects/cursor-background-agent.mdx describing running Cursor's headless CLI as a child process, streaming NDJSON stdout via Realtime Streams to a frontend, and rendering a live terminal UI, including architecture, code references, and a demo. It also updates docs/docs.json and docs/guides/introduction.mdx to include the new example in the Example projects listings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete and does not follow the required template structure with sections for Testing, Changelog, and Checklist. Update the PR description to include all required sections: Checklist (with verification items), Testing (describe steps taken to test), Changelog (short description of changes), and Screenshots (if applicable).
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the primary change: adding documentation for a Cursor background agent example project.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/background-cursor-demo

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/guides/example-projects/cursor-background-agent.mdx`:
- Line 16: The "Cursor CLI" tech-stack link currently points to the homepage
("**[Cursor CLI](https://cursor.com)**"); update that anchor to point to the
CLI-specific page by changing the URL to https://cursor.com/cli so the "**Cursor
CLI**" link consistently directs users to the CLI documentation page.
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc63edd and c6575c3.

📒 Files selected for processing (3)
  • docs/docs.json
  • docs/guides/example-projects/cursor-background-agent.mdx
  • docs/guides/introduction.mdx
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,jsx,tsx,json,md,yaml,yml}

📄 CodeRabbit inference engine (AGENTS.md)

Format code using Prettier before committing

Files:

  • docs/docs.json
🧠 Learnings (3)
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `.withStreams()` to subscribe to realtime streams from task metadata in addition to run changes

Applied to files:

  • docs/guides/example-projects/cursor-background-agent.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use the `task()` function from `trigger.dev/sdk/v3` to define tasks with id and run properties

Applied to files:

  • docs/guides/example-projects/cursor-background-agent.mdx
📚 Learning: 2025-11-27T16:27:35.304Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Subscribe to run updates using `runs.subscribeToRun()` for realtime monitoring of task execution

Applied to files:

  • docs/guides/example-projects/cursor-background-agent.mdx
🔇 Additional comments (4)
docs/guides/example-projects/cursor-background-agent.mdx (2)

1-105: Documentation looks well-structured and comprehensive overall.

The new guide clearly explains the architecture, provides relevant code snippets, and links to the full example repo. The content is well-organized with a logical flow from overview → video → how it works → relevant code.


38-45: The codebase shows that icon="GitHub" (capitalized) is the predominant and consistent convention across 28+ documentation files, while only 3 files use lowercase. The file already follows the standard pattern. No change needed.

Likely an incorrect or invalid review comment.

docs/docs.json (1)

380-380: LGTM!

New entry is correctly placed in alphabetical order within the Example projects navigation group.

docs/guides/introduction.mdx (1)

59-59: LGTM!

Table entry is correctly positioned alphabetically, and the description, framework, and repo link are consistent with the new guide page.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

@D-K-P D-K-P merged commit ebffa10 into main Feb 10, 2026
9 checks passed
@D-K-P D-K-P deleted the docs/background-cursor-demo branch February 10, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants