Skip to content

docs: add Cursor Cloud pscale build/install notes to AGENTS.md #1291

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.

Sign up for GitHub

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

Closed
heyglassy wants to merge 2 commits into from
Closed

docs: add Cursor Cloud pscale build/install notes to AGENTS.md #1291

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0fbafb
docs: add Cursor Cloud pscale build/install notes to AGENTS.md
cursoragent Jul 13, 2026
162e021
docs: note pscale keyring/D-Bus workaround for Cursor Cloud
cursoragent Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,3 +242,38 @@ git clone https://github.com/planetscale/skills.git && cd skills && script/setup
```

After installing skills, load `14-pscale-cli-automation` for CLI conventions (or re-run `pscale agent-guide --format json` from any `pscale` binary that includes agent onboarding). Use `00-safe-orchestrator` when the user asks for a full PlanetScale assessment.

## Cursor Cloud specific instructions

To install/rebuild the `pscale` binary from this repo (Go 1.26 is on `PATH`):

```bash
go build -trimpath -o /tmp/pscale ./cmd/pscale && sudo mv -f /tmp/pscale /usr/local/bin/pscale
```

`/usr/local/bin` is already on `PATH`, so `pscale --version` works afterward. The
build entry point is `./cmd/pscale` (`main.version`/`main.commit`/`main.date` can be
set via `-ldflags` if you want an accurate version string). `pscale auth check
--format json` reports `NO_AUTH` until a user runs `pscale auth login` — installing
the CLI does not authenticate it.

### `pscale auth login` hangs on the desktop keyring prompt

`pscale` stores its access token via `99designs/keyring`, preferring the
SecretService (gnome-keyring) backend. In the Cursor Cloud VM the desktop D-Bus
secret service is present but locked, so after you approve the device flow the CLI
**blocks on a "Choose password for new keyring" dialog on the desktop** and never
finishes writing the token (`auth check` keeps reporting `NO_AUTH`).

Work around it by disabling D-Bus so `pscale` falls back to its plaintext file store
at `~/.config/planetscale/access-token`. Prefix the login (and every subsequent
`pscale` command, since reads also open the keyring) with:

```bash
DBUS_SESSION_BUS_ADDRESS=unix:path=/dev/null pscale auth login --format json
DBUS_SESSION_BUS_ADDRESS=unix:path=/dev/null pscale auth check --format json
```

Run `login` non-interactively (e.g. in tmux) and hand the user the `verification_url`
+ `user_code` printed as pending JSON on **stderr**; the final result JSON lands on
**stdout** once approved.