Skip to content

Document the spicedb-dev AI agent plugin - #588

Merged
samkim merged 7 commits into
mainfrom
spicedb-dev-plugin-docs
Sep 18, 2026
Merged

samkim merged 7 commits into
mainfrom
spicedb-dev-plugin-docs

Conversation

@samkim

@samkim samkim commented Sep 16, 2026

Copy link
Copy Markdown
Member

Summary

  • Points to the spicedb-dev Claude Code / Codex CLI / AGENTS.md plugin from the toolchain-install step in First Steps
  • Adds a new "Build with your AI agent" page under Getting Started covering installation, capabilities, and migration
  • Recommends the plugin as a Priority B best practice for regular SpiceDB development
  • Fixes an unrelated sidebar bug where the Best Practices priority links didn't navigate correctly from other pages

Test plan

  • pnpm build succeeds with no errors or broken-link warnings
  • oxfmt --check passes
  • CLI install commands independently verified against Claude Code's and Codex CLI's own source/config
  • Visual review of the new page and nav placement

🤖 Generated with Claude Code

samkim and others added 6 commits September 15, 2026 17:34
…pages

The Essential/Strongly Recommended/Recommended sidebar entries used
bare-hash hrefs, which only worked as in-page scroll anchors on the
Best Practices page itself. From any other page they appended the
hash to the current URL instead of navigating to Best Practices.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgEnJ8XrVePnhSU3scp4jE
…edb-dev plugin

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgEnJ8XrVePnhSU3scp4jE
…toolchain step

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgEnJ8XrVePnhSU3scp4jE
…em-dash overuse, agent-fallback guidance, cross-page consistency)

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgEnJ8XrVePnhSU3scp4jE
…rify CLI syntax

Refer to "an existing authorization solution (OpenFGA, Okta FGA, etc.)"
generically instead of naming specific products as the definitive list;
Auth0 FGA doesn't exist as a distinct product and is dropped. Removes the
implement-spicedb routing explanation, since the plugin already handles
that routing for the user. The Claude Code and Codex CLI install commands
were independently verified against each project's own source (marketplace
name in authzed-marketplace's marketplace.json; codex-rs's plugin_cmd.rs
and marketplace_cmd.rs) and left unchanged, since they were already
correct.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SgEnJ8XrVePnhSU3scp4jE
@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment status for this pull request.

Name Status Preview Updated (UTC)
docs 🟢 Ready Visit Preview Sep 18, 2026 07:28pm

Tags: **application**

If you're using an AI coding agent, install the [`spicedb-dev` plugin](/spicedb/getting-started/build-with-an-agent) from the [AuthZed marketplace](https://github.com/authzed/authzed-marketplace) and keep it in the loop for your regular SpiceDB exploration and development.
It helps you design permission models, generate and validate schemas, add relationship writes and permission checks to your application code, audit coverage as your app grows, and generate tests from your schema, catching common mistakes like checks with no corresponding writes before they reach production.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

add that is also helps with migration from OpenFGA or OSO

- **Implement authorization in code**: relationship writes (`WriteRelationships`, `DeleteRelationships`) and permission checks (`CheckPermission`, `BulkCheckPermission`, `LookupResources`, `LookupSubjects`) in Go, TypeScript, Python, C#, Java, Rust, and Ruby
- **Audit permission coverage** across your codebase: for every permission in your schema, see whether a check exists in code, and catch unfiltered list endpoints, which is useful for debugging and hardening an authorization setup you didn't build with the plugin, too
- **Generate tests**: positive, negative, and hierarchical-inheritance test fixtures and integration tests, generated from your schema
- **Migrate from an existing authorization solution** (OpenFGA, Okta FGA, etc.): convert the model, the relationship data, the application code, and the tests, then verify the migration with a differential test harness before cutover

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

mention OSO here too

Addresses PR review feedback to call out OSO alongside OpenFGA and
Okta FGA as an authorization system the spicedb-dev plugin can help
migrate from.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@josephschorr josephschorr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@samkim
samkim merged commit a4f10cd into main Sep 18, 2026
11 of 12 checks passed
@samkim
samkim deleted the spicedb-dev-plugin-docs branch September 18, 2026 23:20
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 18, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants