docs: clarify --project flag does not resolve names#398
Conversation
The global --project flag (and KERNEL_PROJECT env var) forwards its value verbatim as the X-Kernel-Project-Id header. The CLI only resolves names to IDs for the projects subcommand positional arguments (get, delete, limits). Update reference/cli.mdx, reference/cli/projects.mdx, and info/projects.mdx to reflect this and direct users to pass a project ID for the global flag.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: This PR only modifies documentation files and does not change any service code, so it does not require deploy monitoring. To monitor this PR anyway, reply with |
There was a problem hiding this comment.
Risk assessment: Very Low
The diff only updates three .mdx documentation pages to clarify how the CLI --project flag and KERNEL_PROJECT env var handle project IDs. There are no code, config, prompt-instruction, infrastructure, API, or navigation changes, and the examples/text changes are narrowly scoped to CLI documentation. I also found no CODEOWNERS file and no existing approvals, so this is safe to approve.
Sent by Cursor Automation: Assign PR reviewers


Summary
The docs currently claim the global
--projectflag (andKERNEL_PROJECTenv var) accepts either a project ID or a name and resolves names case-insensitively. That's not actually what the CLI does — it forwards the raw value as theX-Kernel-Project-Idheader without any client-side lookup. Name resolution is only wired into theprojectssubcommand positional arguments (get,delete,limits get,limits set).This PR updates three pages to reflect the real behavior:
reference/cli.mdx— global flags tablereference/cli/projects.mdx— "Scoping commands to a project" sectioninfo/projects.mdx— "Using Projects from the CLI" sectionTest plan
X-Kernel-Project-Id— if it does, we may want to revisit the framingNote
Low Risk
Documentation-only changes with no runtime or API behavior impact.
Overview
Corrects documentation that incorrectly described the global
--projectflag andKERNEL_PROJECTas accepting project names with case-insensitive resolution.info/projects.mdx,reference/cli.mdx, andreference/cli/projects.mdxnow state that those values must be a project ID, are sent unchanged asX-Kernel-Project-Id, and that users should runkernel projects listto find IDs. Examples drop name-based scoping (e.g.staging) in favor ofproj_abc123.The docs also clarify that name resolution still applies only on
kernel projectspositional args (get,delete,limits get,limits set), where the CLI resolves names before calling the API.Reviewed by Cursor Bugbot for commit 35afc3d. Bugbot is set up for automated code reviews on this repo. Configure here.