agentleFS
IvanWng97IvanWng97/pixtuoid/integrations/AGENTS.md

pixtuoid / integrations

AGENTS.md566 starsChanged 2 days agoMITView on GitHub

The Raycast extension in raycast/: a self-contained TypeScript / Node project (NOT Rust) and a thin presenter over the pixtuoid … --json CLI contract. It ships two commands — Manage Sources (connect/disconnect over pixtuoid sources|connect|disconnect --json) and Start Floating. Parent guide: the workspace ../AGENTS.md. This guide sits here, not in raycast/, because the Store review rejects an extension folder that ships an AGENTS.md (no-agent-scaffolding in raycast/extensions' .greptile/config.json). You are in the TS consumer, not the Rust producer. The workspace AGENTS.md…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. pixtuoid/pixtuoid★ 566100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository4 other files it gives its agents.

The file

Files
AGENTS.md

integrations — Raycast extension agent guide

The Raycast extension in raycast/: a self-contained TypeScript / Node project (NOT Rust) and a thin presenter over the pixtuoid … --json CLI contract. It ships two commands — Manage Sources (connect/disconnect over pixtuoid sources|connect|disconnect --json) and Start Floating. Parent guide: the workspace ../AGENTS.md. This guide sits here, not in raycast/, because the Store review rejects an extension folder that ships an AGENTS.md (no-agent-scaffolding in raycast/extensions' .greptile/config.json).

You are in the TS consumer, not the Rust producer. The workspace AGENTS.md still loads above this file — but its Rust house rules (TDD-in-Rust, cargo/clippy, just preflight, the crate CI gates) do not apply here. This is a Node project; the gates are tsc + eslint + npm test. Don't run cargo anything for a change scoped to raycast/; the pre-push hook still runs just preflight.

What it is

A login-shell-resolved shell over the CLI — it does not bundle the binary (resolves it via $PATH + a binaryPath preference). raycast/src/pixtuoid.ts is the CLI bridge; raycast/src/manage-sources.tsx / raycast/src/start-floating.tsx are the Raycast command UIs. No server, no state of its own — every fact comes from the CLI: its --json rows, and Start Floating's ready line, exit code and stderr.

The contract is GENERATED, not hand-mirrored (read this first)

BOTH wire types — SourceStatus AND OutcomeRow — are generated, not hand-typed. The Rust serde types (crates/pixtuoid/src/sources.rs) emit committed JSON Schemas (raycast/contract/source-status.schema.json + raycast/contract/outcome-row.schema.json, via their schemars derives + the *_schema_matches_the_committed_contract golden tests); npm run gen:contract (json-schema-to-typescript) regenerates raycast/src/contract.ts + raycast/src/contract-outcome.ts from those schemas; and raycast/src/pixtuoid.ts re-exports the generated types (export type { SourceStatus } / { OutcomeRow }). So a producer shape change can't hand-drift — three gates catch it: the Rust struct↔schema golden tests (just test), the schema↔TS-type freshness check (raycast CI regenerates both files and git diff --exit-codes them), and the TS-type↔usage tsc --noEmit pass. After changing SourceStatus or OutcomeRow, run just gen-contract (re-emits the schemas + the TS types) and commit all of it. raycast/src/contract.ts / raycast/src/contract-outcome.ts are generated — eslint/prettier-ignored, never hand-edit them. At runtime raycast/src/conforms.ts checks every CLI row against the same committed schemas and fails closed on drift (npm test), so a stale schema there breaks the extension, not only the types. (outcome_row_json_shape pins OutcomeRow's exact wire JSON, the sources --json golden and schema test SourceStatus's; OutcomeRow's doc comment in crates/pixtuoid/src/sources.rs owns the published-wire rule.)

Toolchain policy

raycast/package.json cannot carry a comment, so these live here.

  • Toolchain bumps must stay within what Raycast DECLARES — check the peers, don't guess. eslint/typescript are gated by @raycast/eslint-config's peerDependencies — read the installed version's ranges before a bump; @types/node stays on its current major (.github/dependabot.yml ignores its major updates; minors still flow). @raycast/api's exact peer is a warning-level mismatch npm tolerates under the committed lockfile, not a hard pin the manifest must equal. ray build type-checks with its OWN bundled tsc (read its version from the installed @raycast/api), so raycast/tsconfig.json must stay parseable by BOTH that and the local TS: hence moduleResolution: "Bundler" + an explicit types: ["node"] (TS 6.0 stopped auto-including node_modules/@types), and no ignoreDeprecations value the bundled tsc rejects.

Gates

CI runs .github/workflows/raycast.yml's steps on a Linux runner, on a PR that touches raycast/, and ci-gate judges them; run them locally before "done." ray build writes raycast/raycast-env.d.ts, the manifest's generated Preferences that tsc reads, and ray lint validates the manifest, icons and metadata and runs the Prettier pass. See the README for npm run {build,dev,lint}.

  • Install scripts fail closed, as site's: strict-allow-scripts with an exact-version allowScripts, enforced by the npm 12 CI pins (setup-npm); review with npm install-scripts ls.
  • npm run audit is plain npm audit --audit-level=low, same as site's. npm audit has no per-advisory ignore, so if an unfixable advisory recurs here, restore the per-advisory allow-list script from history rather than lowering --audit-level, which blinds a whole severity band to hide one id. Unfixable is realistic — a transitive chain we own no link of — and an overrides patch can green the audit over code that throws (#792).
  • A chord Raycast RESERVES is swallowed, so its Action is unreachable — and @raycast/no-reserved-shortcut is escalated to error here. Upstream ships it at warn and eslint . exits 0 on warnings, which is how an Open Extension Preferences action bound to ⌘, (Raycast's own OpenPreferences) shipped dead: tsc types the chord fine, and ray lint exits 0 on a warning too. Its sibling @raycast/prefer-common-shortcut stays a warning — style advice a routine version bump could turn into a surprise red.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.