* test(cmd/bd): reset cobra flags between in-process runs; keep them out of parallel tests
runBDInProcess and runBDInProcessAllowError execute the package-level
rootCmd tree again and again in one process, and cobra never resets a
flag between Execute calls: a value one invocation parsed (create's
--title, --labels, list's --status, ...) and its Changed bit stayed on the
FlagSet, so the next invocation saw it, and a slice flag that had been
set appended to the stale value instead of replacing it. With a Dolt test
server (the only setup in which these tests run) that failed about 20
TestCLI_* tests depending on suite order.
TestMain now snapshots every flag of the tree (snapshotCommandFlags,
after all init()s registered them, before any test runs) and both runners
put the tree back before and after each run (resetCommandFlags): the
pointee of each flag.Value is restored (for pflag's scalar types that is
the bound variable; for slice types it also clears the internal "changed"
bit, so the next Set replaces), slice contents via SliceValue.Replace,
and Changed=false. TestResetCommandFlagsRestoresEveryFlag sets every flag
of the real tree and checks the reset. The ad-hoc --title reset in
TestCLI_CreateRejectsEmptyTitle_ProxiedServerMode is no longer needed.
Seven TestCLI_Comment* tests called t.Parallel() around the runners.
inProcessMutex serializes the runners only against each other, so their
chdir, stdio swap, env and config re-initialization raced every other
parallel test (data races on config globals; TestCobraParallelPolicyGuard
failing to read its own source files after a concurrent chdir). They run
serially now, and the guard treats the two runners like rootCmd.Execute.
Also two stale TestCLI_Create* cases: DryRunWithRigPrefix exercised a
create --prefix flag that no longer exists, and the flag-like-title cases
passed "--help" or "--foo-bar" where cobra parses them as flags; they now
pass the title after "--", the only way it reaches create's own guard.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): fix the ADO round-trip and bulk-delete tests that rotted unseen
Both need the integration tag and a Dolt test server, which no CI lane
gave cmd/bd (BEADS_TEST_SKIP=dolt everywhere), so they failed unnoticed:
- TestADORoundTrip* stored ado.pat in the database. ado.pat is a secret
read only from config.yaml or AZURE_DEVOPS_PAT (config.IsYamlOnlyKey),
so the tracker found no PAT. The fixture sets AZURE_DEVOPS_PAT.
- TestBulkDeleteNoResurrection expected GetIssue to return (nil, nil) for
a deleted issue; the Dolt store reports storage.ErrNotFound.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): fix parity, completion and notion tests that only fail with a Dolt server
These are Dolt-gated (integration tag + test server), so no CI lane ran
them and they rotted:
- TestParityCreate*/TestParityReopenErrorExits1Silently: bd create
auto-routes via routing.DetectUserRole("."), which warns "beads.role
not configured (GH#2950)" on stderr when the working directory's git
config has no beads.role. The suite pins the configured case, so the
parity env now sets beads.role=maintainer in a test-owned global git
config ($XDG_CONFIG_HOME/git/config; the role lookup scrubs every
GIT_CONFIG_* variable, so those cannot be used).
- TestIssueIDCompletion: issueIDCompletion resolves a database path
before looking at the open store and returns nothing when there is
none; the test now sets dbPath to its store's path.
- TestIssueIDCompletion_UsesWorktreeFallbackWhenStoreNil and
TestGetNotionConfigReadsDBPathWhenStoreUnset: the code under test
reopens the store from metadata.json, which names a database but not
the per-test branch of the shared database that newTestStore uses, so
the reopened store saw none of the test's rows. They now use their own
database (newTestStoreIsolatedDB).
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): fix stale doctor/e2e/autocommit/readonly Dolt-gated tests
These need the integration tag and a Dolt test server, which no CI lane
gave cmd/bd, so they rotted unseen:
- TestE2E_DoctorFixMetadataRoundtrip, TestE2E_MigrateDoltMetadata,
TestDoctorCheckHealthReportsVersionMismatchOnRepoLocalPort: bd init now
defaults to embedded mode, where `bd sql` and `bd dolt start` are
refused. Init with --server on a repo-local server of their own
(repoLocalServerEnv: the suite's shared-server port vars cleared, server
stopped at cleanup) and start it explicitly, since BEADS_TEST_MODE=1 never
auto-starts one. MigrateDoltMetadata's DELETE also needed `key` quoted.
- TestDoctor{Conventions,Pollution}MaxRows_EnvOnly_Exits2: bdRunRaw drops
every BEADS_* variable, so the subprocess hit dolt.New's test-database
firewall (exit 1) before the row cap; pass BEADS_TEST_SERVER=1.
- TestDoltAutoCommit_On_WritesAdvanceHead: the embedded engine keeps its
data under .beads/embeddeddolt, not .beads/dolt; findDoltRepoDir looks
in both.
- TestValidateCheck_AllClean: bd doctor validate runs five checks since
the cross-table duplicates check was added.
- TestConfigValidateReadOnlyIsHermetic: readonly commands take a shared
workspace gate, whose lock file (.beads/dolt.gate.lock) workspacegate
creates on first use by design; compare the .beads tree without gate
lock files.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): undo each in-process execution's env and storage-mode leaks
Every in-process run of the bd command tree (runBDInProcess and the many
tests that call rootCmd.Execute directly) leaves process state behind:
PersistentPreRun exports the selected workspace as BEADS_DIR, loads its
.beads/.env, and records the workspace's mode in serverMode /
proxiedServerMode. With a Dolt test server, later tests in the same shard
then resolved a deleted fixture ("no active beads workspace found",
"migration sidecar is missing"), ran subprocess bd against the wrong
workspace ("recorded as proxied-server in .beads/metadata.json"), or took
the proxied path in RunE-level tests ("proxied-server UOW provider not
initialized", a nil-UOW panic in reopenProxiedResolve that killed a shard).
TestMain now registers a cobra initializer/finalizer pair
(installExecuteIsolation) that snapshots the environment and the two mode
globals when an execution starts and restores them when it ends; the
runners' restoreEnvSnapshot shares the helper. TestDoltConfigEnvironmentOverrides
used os.Setenv + defer os.Unsetenv, which deleted the suite's
BEADS_DOLT_SERVER_PORT (the test server's port) for every later test; it
uses t.Setenv now.
Full integration-tagged cmd/bd suite against a hermetic dolt (16 shards):
18 order-dependent failures and the shard panic gone; the 27 remaining
failures all fail alone too.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* fix(init): keep --quiet quiet through the Claude/Codex/Cursor auto-setup
`bd init --quiet` ("Suppress output") still printed the project
integration installers' progress to stdout ("Installing Claude hooks for
this project...", "Claude Code integration installed", ...): the
installers write to os.Stdout unconditionally. Point stdout at the null
device around them while quiet; their failures keep going to stderr as
before. Found by TestInitCommand's quiet case, which asserts no output and
had not run in CI (Dolt-gated).
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(init): bring the Dolt-gated init tests up to the current init contract
These tests need a Dolt test server, so no CI lane ran them and they
drifted from the product:
- Embedded is init's default mode, so the server-mode assertions
(.beads/dolt, opening the database on the test server, dolt_mode
"server" in metadata.json) now pass --server (TestInitCommand,
TestInitAlreadyInitialized, TestInitRedirect, TestInitBEADS_DIR,
TestInitDoltMetadata, TestInitDoltMetadataNoGit, TestInitDatabaseFlag's
metadata subtests). The in-process ones reset rootCmd's flags around
themselves so --server cannot leak into later in-process inits.
- Each server init gets its own --database: the suite shares one test
server, and a "test" database another test created belongs to another
project (init refuses: PROJECT IDENTITY MISMATCH).
- The marker tests seed a current-era version witness: the legacy-upgrade
guard refuses a non-empty .beads/dolt without one.
- The redirect test provisions the canonical target with config.yaml: bd
ignores a redirect to a directory with no project files (#4692).
- Shared-server inits get a free port of their own
(sharedServerTestEnv): the inherited BEADS_DOLT_SERVER_PORT is the
suite's test server, which a shared-server start refuses as another
project's, and the default shared port is 3308, a developer's live
server.
- --shared-server's config.yaml is now nested YAML (dolt: shared-server:
true); parse it instead of matching the old flat line.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): run the Dolt-gated tests that skipped on a bare dolt.New
setupTestDB (config, kv and Linear round-trip tests), setupGatedTestDB
(mol ready --gated) and the rename-prefix and bd sql tests opened stores
with dolt.New(&dolt.Config{Path: ...}): no server port, no
CreateIfMissing, so against a running test server they got "database ...
not found" and skipped as "Dolt server not available". They now use the
suite's newTestStore helpers (skip only when no test server runs), and
what that exposed is fixed test-side:
- TestCustomStatusConfig: custom_statuses is read back ORDER BY name;
look statuses up by name / expect name order.
- TestLinearRoundTripCoreFields, TestLinearPullMilestonesCreatesEpicHierarchy:
linear.api_key is a yaml-only secret (LINEAR_API_KEY), push now needs an
explicit linear.state_map, and batch push uses TeamLabels and
issueBatchCreate, which the mock server now answers.
- TestSqlCommand: bd sql refuses in the default embedded mode; set
serverMode for the server-backed store, and stop discarding RunE errors.
- TestE2E_AutoStartedRepoLocalServerPersistsAcrossCommands skipped on
this process's embedded mode although every bd it runs is a subprocess
on a --server workspace; gate on the dolt binary instead and stop the
auto-started server at cleanup.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): no fixed "unused" port, no swallowed JSON, no leaked front-door server
Three more things the Dolt-backed cmd/bd run exposed:
- TestTestServerConnection, TestSharedServerCfgNilHonorsSharedServer and
the two TestLegacyGuard* e2e tests pointed bd at 127.0.0.1:59999 as a
port nothing listens on. Any process on the host may hold it; a
listener that accepts and resets turns the expected "connection
refused" / "Dolt server unreachable" into another error. They take a
just-freed port from closedLoopbackPort (testutil.FindFreePort) now.
- TestDoltSetConfigJSONOutput and TestDoltSetConfigWithUpdateConfig
created .beads 0755, so bd's permissions warning landed in the JSON
under test and the tests skipped ("output not pure JSON") every run.
The fixture uses 0700, and non-JSON output fails instead of skipping.
- TestMigrateDoltModeFrontDoor's closing show/list auto-start a
repo-local server after the reverse migration; nothing stopped it, so
the suite's leak check failed (when the opt-in
BEADS_TEST_MIGRATION_FRONTDOOR suite runs). It stops it at cleanup.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* ci(bazel): advisory cmd/bd Dolt-server tier (bazel-cmd-dolt)
No CI lane ran cmd/bd's Dolt-gated tests (TestCLI_*, the init and
store-backed suites, the doctor/e2e tests): main.yml's integration shards,
nightly's Full Test Suite, and Bazel's --config=prcore/ci and
--config=integration all pass BEADS_TEST_SKIP=dolt, so cmd/bd's TestMain
never starts a test server and those tests skip; the proxied and embedded
tiers run only their manifests' tests. They rotted unseen.
//cmd/bd:bd_dolt_server_test (tag dolt-server-cmd) runs the whole
integration-tagged cmd/bd suite, the integration build's bd_test, against
a hermetic dolt sql-server: BEADS_TEST_DOLT_SERVER=local starts it from
the pinned dolt in the test wrapper's runfiles, and
BEADS_TEST_REQUIRE_DOLT_CONTAINER=1 fails the target instead of skipping
into a cached pass. No test selection: the Go binary shards itself over
every top-level test (32 shards), so each runs exactly once, and
check_testcases.py fails a shard that ran none. --config=doltserver-cmd
has exactly --config=integration's build flags, so the two lanes share
bd_test's compile; prcore/ci and integration exclude the tag.
bazel.yml's new bazel-cmd-dolt job runs it exactly where bazel-integration
runs (same if: remotely on the farm for same-repo PRs, fork-ro/fork-rw,
and locally with the read-only cache in mode cache for forks). It is
advisory: job-level continue-on-error keeps a failure out of the call's
aggregate (BAZEL), and pr.yml's ci-gate reads its result (BAZEL_CMD_DOLT)
but requires it only while the committed top-level flag
BAZEL_CMD_DOLT_REQUIRED is "true" (now "false"; flipping it is the one
change needed). bazel-gate.sh accepts its skip in modes skip and local.
Policy tests: a third lane category in TestBazelLaneIsGatedAlongsideLegacy
(bazelFlagGatedLanes: gate env wired, never statically required, added by
the run script exactly when the pinned flag is "true"), the gate
simulation over every mode with the flag off (advisory: nothing it
reports reddens the gate) and on (exactly a gated lane), the cache-mode
and execution-mode checks, the tag taxonomy and prcore/integration
exclusions, and TestBazelCmdDoltJob (job steps, timeouts, .bazelrc
config equal to integration's build with no dolt skip or test selection,
the target's dolt-server rules, and bd_test's env repeated).
Measured locally (all fixes in this series, 32 shards, 16 at a time on a
shared host): 3267 top-level tests, all shards pass, max shard 313s (one
5001-issue export test, 214s, sets it), mean 100s.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* fix(init): hand the project installers a writer instead of swapping os.Stdout
The --quiet fix earlier in this series pointed the process-global
os.Stdout at the null device around the Claude/Codex/Cursor installers.
That works, but it mutates a global from inside a cobra Run: anything else
writing to stdout meanwhile (a goroutine, a future concurrent installer)
would vanish, and a concurrent read of os.Stdout is a data race.
The installers already write through env structs with stdout/stderr
fields. setup.ProjectInstallOutput carries the two writers, and
InstallClaudeProjectTo / InstallCodexProjectTo / InstallCursorProjectTo
use them (the old entry points keep the process streams). init passes
QuietProjectInstallOutput() under --quiet: progress discarded, error lines
still on stderr. The proxied-server init path (domain adapter
InstallClaudeProject now takes quiet) does the same, so its
"Installing Claude hooks..." is quiet too.
Consistent error policy under --quiet: errors still reach stderr. init's
own "Warning: failed to setup <installer>" lines were suppressed under
--quiet while the installers' "Error:" lines were not, and some installer
failures (Cursor rules) print nothing themselves; the warnings now print
whether or not quiet, like the installers' errors.
Coverage in required lanes: TestProjectInstallersReportToTheGivenOutput
(cmd/bd/setup) and TestEmbeddedInitA/basic, which now asserts that
`bd init --quiet` with agents enabled installs the Claude hooks and prints
none of the installers' progress (verified to fail with the quiet output
disabled).
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(export): exercise the incremental-export fallback with a small threshold
TestTryIncrementalExport_ThresholdExceededFallsBack seeded
incrementalExportThreshold+1 = 5001 issues to cross the threshold. Batch
create is one transaction but still several statements per issue, so under
-race against the shared test server it took ~214 s, the longest test in
cmd/bd's Dolt-backed suite by far. The behaviour under test is only
"more changed issues than the threshold -> full export fallback".
incrementalExportThreshold becomes a var (same value), and the test, which
is not parallel, sets it to 20 and seeds 21 issues: 214 s -> 0.6 s.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* test(cmd/bd): tighten the flag-reset self-test, guards and canaries
Review follow-ups:
- TestResetCommandFlagsRestoresEveryFlag no longer skips a flag it cannot
set: a flag type without a sample value, a Set error, or a non-pointer
Value (which resetCommandFlags could not restore) is an error, so a new
flag type cannot go untested. resetCommandFlags documents that it also
resets flag-bound package globals.
- TestCobraParallelPolicyGuard treats .ExecuteC/.ExecuteContext/
.ExecuteContextC like .Execute (the per-execution isolation writes the
mode globals; a parallel execution would race).
- TestConfigValidateReadOnlyIsHermetic ignores only the gate a readonly
command takes (.beads/dolt.gate.lock and its .info sidecar), not any
"*.gate.lock*" file, so a new unexpected gate still trips the canary.
- TestCLI_CreateRejectsFlagLikeTitles: a bare `bd create --foo-bar` must
fail and create no issue (bd-2c0's intent), next to the "--" cases.
- TestCustomStatusConfig cites why statuses come back in name order: the
normalized custom_statuses table (#2961, 8537d943b) has no ordinal and is
read ORDER BY name, like custom_types; the test predates it.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* ci(bazel): run the cmd/bd Dolt-server tier in 16 shards
Each shard pays ~30-40 s of fixed cost (TestMain plus its own dolt
sql-server), so 32 shards spent roughly 40% of the lane's executor time on
setup and added 32 farm actions to every PR touching cmd/bd. With the
5001-issue export test cut to under a second, 16 shards measure (locally,
--nocache_test_results): max 186 s, mean 137 s, 2,187 executor-seconds
(vs ~2,800-3,200 at 32), all 3,267 top-level tests, every shard passing.
TestBazelCmdDoltJob pins the count; bazel.yml's timing comment is
restated (cache mode ~20-30 minutes).
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Gas City Adopt-PR <adopt-pr@gascity.local>
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
500 lines
15 KiB
Go
500 lines
15 KiB
Go
package setup
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/steveyegge/beads/internal/recipes"
|
|
)
|
|
|
|
const (
|
|
cursorRulesPath = ".cursor/rules/beads.mdc"
|
|
cursorHooksPath = ".cursor/hooks.json"
|
|
// cursorHookCommandPrefix identifies hook entries that bd owns, so we can
|
|
// upsert/remove them without disturbing a user's own Cursor hooks.
|
|
cursorHookCommandPrefix = "bd cursor-hook "
|
|
)
|
|
|
|
// cursorManagedHookEvents is the ordered list of Cursor agent lifecycle events
|
|
// bd manages, and the single source of truth for "which events bd installs
|
|
// hooks for". cursorManagedHooks derives each command from it, and the doctor
|
|
// package consumes it via CursorManagedHookEventNames / CursorManagedHookEvents,
|
|
// so the installer and diagnostics can't drift. Order matters for user-facing
|
|
// messages (e.g. bd doctor hook completeness).
|
|
var cursorManagedHookEvents = []string{"sessionStart", "preCompact", "postToolUse"}
|
|
|
|
// cursorManagedHooks maps each managed Cursor lifecycle event to the command
|
|
// that handles it (the hidden `bd cursor-hook <event>` command), so `bd` must be
|
|
// on PATH when Cursor runs them. These events fire in the Cursor IDE and in
|
|
// recent cursor-agent CLI builds (verified on the 2026.06 line; early-2026 CLI
|
|
// builds only fired shell hooks).
|
|
func cursorManagedHooks() map[string]string {
|
|
hooks := make(map[string]string, len(cursorManagedHookEvents))
|
|
for _, event := range cursorManagedHookEvents {
|
|
hooks[event] = cursorHookCommandPrefix + event
|
|
}
|
|
return hooks
|
|
}
|
|
|
|
// CursorManagedHookEventNames returns the ordered list of Cursor lifecycle
|
|
// events bd manages. Exported so the doctor package reports hook completeness
|
|
// against the same definition the installer writes.
|
|
func CursorManagedHookEventNames() []string {
|
|
out := make([]string, len(cursorManagedHookEvents))
|
|
copy(out, cursorManagedHookEvents)
|
|
return out
|
|
}
|
|
|
|
// CursorManagedHookEvents returns the managed events in a parsed .cursor/hooks.json
|
|
// config that have a bd-managed hook entry (a "bd cursor-hook " command). It is
|
|
// the single source of truth for detecting bd's Cursor hooks, shared by the
|
|
// setup and doctor packages.
|
|
func CursorManagedHookEvents(config map[string]interface{}) []string {
|
|
hooks, ok := config["hooks"].(map[string]interface{})
|
|
if !ok {
|
|
return nil
|
|
}
|
|
var found []string
|
|
for _, event := range cursorManagedHookEvents {
|
|
for _, entry := range toInterfaceSlice(hooks[event]) {
|
|
if cursorHookEntryManaged(entry) {
|
|
found = append(found, event)
|
|
break
|
|
}
|
|
}
|
|
}
|
|
return found
|
|
}
|
|
|
|
// cursorHooksTargetPath resolves where hooks.json lives. Project installs use
|
|
// the repo-local .cursor/hooks.json (committed with the project, per Cursor's
|
|
// docs); global installs use ~/.cursor/hooks.json, which Cursor documents as the
|
|
// user-level hooks location. Note: Cursor has no reliable file-based global
|
|
// *rules* location (those live in Cursor Settings), so --global covers hooks
|
|
// only.
|
|
func cursorHooksTargetPath(global bool) (string, error) {
|
|
if !global {
|
|
return cursorHooksPath, nil
|
|
}
|
|
home, err := os.UserHomeDir()
|
|
if err != nil {
|
|
return "", fmt.Errorf("resolve home directory: %w", err)
|
|
}
|
|
return filepath.Join(home, ".cursor", "hooks.json"), nil
|
|
}
|
|
|
|
// cursorRulesTemplate is the `.cursor/rules/beads.mdc` content: Cursor `.mdc`
|
|
// frontmatter (alwaysApply makes the rule load every conversation) wrapping the
|
|
// canonical beads workflow template shared by every file-based recipe. Reusing
|
|
// recipes.Template (rather than a Cursor-specific copy) keeps Cursor's rule at
|
|
// parity with peers like windsurf/cody and avoids drift. HTML-comment markers
|
|
// match the BEGIN/END BEADS INTEGRATION style used in AGENTS.md / CLAUDE.md.
|
|
const cursorRulesTemplate = `---
|
|
alwaysApply: true
|
|
---
|
|
|
|
<!-- BEGIN BEADS INTEGRATION -->
|
|
<!-- Auto-generated by 'bd setup cursor'. Content between these markers is managed by bd. -->
|
|
|
|
` + recipes.Template + `
|
|
<!-- END BEADS INTEGRATION -->
|
|
`
|
|
|
|
// InstallCursor installs Cursor integration. Project scope (default) writes an
|
|
// always-applied rules file plus agent lifecycle hooks; global scope writes the
|
|
// hooks to ~/.cursor/hooks.json (rules are project-only — see
|
|
// cursorHooksTargetPath). The hooks auto-run `bd prime` on session start and
|
|
// recover context after compaction.
|
|
func InstallCursor(global bool) error {
|
|
fmt.Println("Installing Cursor integration...")
|
|
|
|
if !global {
|
|
if err := installCursorRules(); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
}
|
|
|
|
// The agent skill lives at .agents/skills/beads (project) or
|
|
// ~/.agents/skills/beads (global), both of which Cursor loads natively.
|
|
// Unlike rules, skills have a real global location, so --global installs it.
|
|
skillEnv, err := cursorAgentSkillEnv(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
if err := installAgentSkill(skillEnv); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
hooksPath, err := cursorHooksTargetPath(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
if err := installCursorHooks(hooksPath); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
fmt.Printf("\n✓ Cursor integration installed\n")
|
|
if !global {
|
|
fmt.Printf(" Rules: %s\n", cursorRulesPath)
|
|
}
|
|
fmt.Printf(" Skill: %s\n", agentSkillPath(skillEnv.projectDir))
|
|
fmt.Printf(" Hooks: %s (sessionStart, preCompact, postToolUse)\n", hooksPath)
|
|
if global {
|
|
fmt.Println("\nGlobal hooks apply to every project. Cursor has no reliable file-based")
|
|
fmt.Println("global rules location, so add global rules via Cursor Settings → Rules")
|
|
fmt.Println("(or run 'bd setup cursor' per project to install the rules file).")
|
|
}
|
|
fmt.Println("\nThe hooks invoke `bd cursor-hook`, so make sure `bd` is on PATH for Cursor.")
|
|
fmt.Println("Restart Cursor (or start a new cursor-agent session) for changes to take effect.")
|
|
return nil
|
|
}
|
|
|
|
// InstallCursorProject installs project-local Cursor integration, returning an
|
|
// error instead of exiting. Used by bd init to integrate Cursor setup
|
|
// automatically (parallels InstallClaudeProject / InstallCodexProject).
|
|
func InstallCursorProject() error {
|
|
return InstallCursorProjectTo(ProjectInstallOutput{})
|
|
}
|
|
|
|
// InstallCursorProjectTo is InstallCursorProject reporting to out.
|
|
func InstallCursorProjectTo(out ProjectInstallOutput) error {
|
|
if err := installCursorRules(); err != nil {
|
|
return err
|
|
}
|
|
skillEnv, err := cursorAgentSkillEnv(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
skillEnv.stdout, skillEnv.stderr = out.stdout(), out.stderr()
|
|
if err := installAgentSkill(skillEnv); err != nil {
|
|
return err
|
|
}
|
|
if err := installCursorHooks(cursorHooksPath); err != nil {
|
|
return err
|
|
}
|
|
_, _ = fmt.Fprintln(out.stdout(), "✓ Cursor integration installed (rules + skill + hooks)")
|
|
return nil
|
|
}
|
|
|
|
// cursorAgentSkillEnv builds the environment for installing/removing the shared
|
|
// beads agent skill at .agents/skills/beads (project) or ~/.agents/skills/beads
|
|
// (global). This is the same skill Codex installs; Cursor loads .agents/skills/
|
|
// natively, so Cursor-only users get it too. See installAgentSkill.
|
|
func cursorAgentSkillEnv(global bool) (agentSkillEnv, error) {
|
|
base := "."
|
|
if global {
|
|
home, err := os.UserHomeDir()
|
|
if err != nil {
|
|
return agentSkillEnv{}, fmt.Errorf("resolve home directory: %w", err)
|
|
}
|
|
base = home
|
|
}
|
|
return agentSkillEnv{
|
|
stdout: os.Stdout,
|
|
stderr: os.Stderr,
|
|
projectDir: base,
|
|
ensureDir: EnsureDir,
|
|
readFile: os.ReadFile,
|
|
writeFile: func(path string, data []byte) error {
|
|
return atomicWriteFile(path, data)
|
|
},
|
|
removeFile: os.Remove,
|
|
}, nil
|
|
}
|
|
|
|
func installCursorRules() error {
|
|
if err := EnsureDir(filepath.Dir(cursorRulesPath), 0o755); err != nil {
|
|
return err
|
|
}
|
|
if err := atomicWriteFile(cursorRulesPath, []byte(cursorRulesTemplate)); err != nil {
|
|
return fmt.Errorf("write rules: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func installCursorHooks(path string) error {
|
|
if err := EnsureDir(filepath.Dir(path), 0o755); err != nil {
|
|
return err
|
|
}
|
|
config, err := readCursorHooks(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if config == nil {
|
|
config = map[string]interface{}{}
|
|
}
|
|
upsertCursorManagedHooks(config)
|
|
return writeCursorHooks(path, config)
|
|
}
|
|
|
|
// CheckCursor reports whether the managed hooks are present. For project scope
|
|
// it also verifies the rules file; global rules can't be verified from disk
|
|
// (they live in Cursor Settings), so global scope checks hooks only.
|
|
func CheckCursor(global bool) error {
|
|
missing := false
|
|
|
|
if !global {
|
|
if FileExists(cursorRulesPath) {
|
|
fmt.Printf("✓ Cursor rules installed: %s\n", cursorRulesPath)
|
|
} else {
|
|
fmt.Printf("✗ Cursor rules not installed: %s\n", cursorRulesPath)
|
|
missing = true
|
|
}
|
|
}
|
|
|
|
hooksPath, err := cursorHooksTargetPath(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
installed, err := cursorHooksInstalled(hooksPath)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
if installed {
|
|
fmt.Printf("✓ Cursor hooks installed: %s\n", hooksPath)
|
|
} else {
|
|
fmt.Printf("✗ Cursor hooks not installed: %s\n", hooksPath)
|
|
missing = true
|
|
}
|
|
|
|
setupCmd := "bd setup cursor"
|
|
if global {
|
|
setupCmd = "bd setup cursor --global"
|
|
}
|
|
skillEnv, err := cursorAgentSkillEnv(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
if err := checkAgentSkill(skillEnv, setupCmd); err != nil {
|
|
missing = true
|
|
}
|
|
|
|
if missing {
|
|
return HandleErrorWithHint("Cursor integration incomplete", "Run: "+setupCmd)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// RemoveCursor removes bd-managed hook entries (and, for project scope, the
|
|
// rules file), preserving any non-bd hooks the user configured.
|
|
func RemoveCursor(global bool) error {
|
|
fmt.Println("Removing Cursor integration...")
|
|
|
|
hooksPath, err := cursorHooksTargetPath(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
rulesExisted := false
|
|
if !global {
|
|
rulesExisted = FileExists(cursorRulesPath)
|
|
if rulesExisted {
|
|
if err := os.Remove(cursorRulesPath); err != nil && !os.IsNotExist(err) {
|
|
return HandleError("failed to remove rules: %v", err)
|
|
}
|
|
// Best-effort: drop the rules dir if it is now empty.
|
|
_ = os.Remove(filepath.Dir(cursorRulesPath))
|
|
}
|
|
}
|
|
|
|
hooksExisted := FileExists(hooksPath)
|
|
if err := removeCursorHooks(hooksPath); err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
|
|
// The agent skill is shared with Codex (same .agents/skills/beads path).
|
|
// Only remove it if Codex isn't still relying on it.
|
|
skillEnv, err := cursorAgentSkillEnv(global)
|
|
if err != nil {
|
|
return HandleError("%v", err)
|
|
}
|
|
skillExisted := FileExists(agentSkillPath(skillEnv.projectDir))
|
|
skillRemoved := false
|
|
if codexIntegrationInstalled(global) {
|
|
fmt.Println("Keeping Beads agent skill (still used by Codex integration)")
|
|
} else if err := removeAgentSkill(skillEnv); err != nil {
|
|
return HandleError("%v", err)
|
|
} else {
|
|
skillRemoved = skillExisted
|
|
}
|
|
|
|
// Only claim removal for what we actually removed. The shared agent skill is
|
|
// kept when Codex still relies on it, so a lone kept skill is not a Cursor
|
|
// integration and must not report as "removed".
|
|
if rulesExisted || hooksExisted || skillRemoved {
|
|
fmt.Println("✓ Removed Cursor integration")
|
|
} else {
|
|
fmt.Println("No Cursor integration found")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// cursorBeadsHooksPresent reports whether a parsed hooks.json config contains any
|
|
// bd-managed Cursor hook entry (command prefixed with "bd cursor-hook ").
|
|
func cursorBeadsHooksPresent(config map[string]interface{}) bool {
|
|
return len(CursorManagedHookEvents(config)) > 0
|
|
}
|
|
|
|
// codexIntegrationInstalled reports whether Codex's bd integration is present for
|
|
// the given scope (its AGENTS.md managed section or a bd-managed .codex/hooks.json).
|
|
// Cursor removal uses this to avoid deleting the shared .agents/skills/beads skill
|
|
// while Codex still needs it. Checking both surfaces keeps this symmetric with
|
|
// cursorIntegrationInstalledAt, which inspects .cursor/hooks.json and the rules file.
|
|
func codexIntegrationInstalled(global bool) bool {
|
|
env, err := codexEnvProvider()
|
|
if err != nil {
|
|
return false
|
|
}
|
|
if data, err := env.readFile(codexInstructionsPath(env, global)); err == nil {
|
|
if _, ok := extractCodexManagedSection(string(data)); ok {
|
|
return true
|
|
}
|
|
}
|
|
if data, err := env.readFile(codexHooksPath(env, global)); err == nil {
|
|
if config, perr := parseHooksJSON(data); perr == nil && codexBeadsHooksPresent(config) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// readCursorHooks loads a hooks.json file (project or ~/.cursor). It returns
|
|
// (nil, nil) when the file does not exist so callers can distinguish "absent"
|
|
// from "empty".
|
|
func readCursorHooks(path string) (map[string]interface{}, error) {
|
|
data, err := os.ReadFile(path) // #nosec G304 -- fixed .cursor/hooks.json config path (project or home)
|
|
if os.IsNotExist(err) {
|
|
return nil, nil
|
|
}
|
|
if err != nil {
|
|
return nil, fmt.Errorf("read %s: %w", path, err)
|
|
}
|
|
config, err := parseHooksJSON(data)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("parse %s: %w", path, err)
|
|
}
|
|
return config, nil
|
|
}
|
|
|
|
func writeCursorHooks(path string, config map[string]interface{}) error {
|
|
if _, ok := config["version"]; !ok {
|
|
config["version"] = 1
|
|
}
|
|
data, err := marshalHooksJSON(config)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal %s: %w", path, err)
|
|
}
|
|
if err := atomicWriteFile(path, data); err != nil {
|
|
return fmt.Errorf("write %s: %w", path, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func upsertCursorManagedHooks(config map[string]interface{}) {
|
|
hooks, ok := config["hooks"].(map[string]interface{})
|
|
if !ok {
|
|
hooks = map[string]interface{}{}
|
|
config["hooks"] = hooks
|
|
}
|
|
for event, command := range cursorManagedHooks() {
|
|
entries := removeCursorManagedEntries(toInterfaceSlice(hooks[event]))
|
|
entries = append(entries, map[string]interface{}{"command": command})
|
|
hooks[event] = entries
|
|
}
|
|
}
|
|
|
|
func removeCursorHooks(path string) error {
|
|
config, err := readCursorHooks(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if config == nil {
|
|
return nil
|
|
}
|
|
hooks, ok := config["hooks"].(map[string]interface{})
|
|
if ok {
|
|
for event := range cursorManagedHooks() {
|
|
entries := removeCursorManagedEntries(toInterfaceSlice(hooks[event]))
|
|
if len(entries) == 0 {
|
|
delete(hooks, event)
|
|
} else {
|
|
hooks[event] = entries
|
|
}
|
|
}
|
|
if len(hooks) == 0 {
|
|
delete(config, "hooks")
|
|
}
|
|
}
|
|
|
|
// If nothing but the schema version remains, the file was ours; remove it.
|
|
if cursorHooksConfigEmpty(config) {
|
|
if err := os.Remove(path); err != nil && !os.IsNotExist(err) {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
return writeCursorHooks(path, config)
|
|
}
|
|
|
|
func cursorHooksInstalled(path string) (bool, error) {
|
|
config, err := readCursorHooks(path)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
if config == nil {
|
|
return false, nil
|
|
}
|
|
hooks, ok := config["hooks"].(map[string]interface{})
|
|
if !ok {
|
|
return false, nil
|
|
}
|
|
for event, command := range cursorManagedHooks() {
|
|
if !cursorHooksHasCommand(toInterfaceSlice(hooks[event]), command) {
|
|
return false, nil
|
|
}
|
|
}
|
|
return true, nil
|
|
}
|
|
|
|
func removeCursorManagedEntries(entries []interface{}) []interface{} {
|
|
filtered := entries[:0]
|
|
for _, entry := range entries {
|
|
if !cursorHookEntryManaged(entry) {
|
|
filtered = append(filtered, entry)
|
|
}
|
|
}
|
|
return filtered
|
|
}
|
|
|
|
func cursorHookEntryManaged(entry interface{}) bool {
|
|
m, ok := entry.(map[string]interface{})
|
|
if !ok {
|
|
return false
|
|
}
|
|
command, _ := m["command"].(string)
|
|
return strings.HasPrefix(command, cursorHookCommandPrefix)
|
|
}
|
|
|
|
func cursorHooksHasCommand(entries []interface{}, command string) bool {
|
|
for _, entry := range entries {
|
|
m, ok := entry.(map[string]interface{})
|
|
if !ok {
|
|
continue
|
|
}
|
|
if got, _ := m["command"].(string); got == command {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func cursorHooksConfigEmpty(config map[string]interface{}) bool {
|
|
for key := range config {
|
|
if key != "version" {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|