docs: headless & AI — CLI reference for the new commands + AI & MCP tab#14
Open
Gawtier wants to merge 4 commits into
Open
docs: headless & AI — CLI reference for the new commands + AI & MCP tab#14Gawtier wants to merge 4 commits into
Gawtier wants to merge 4 commits into
Conversation
…oles/users/teams/environments) The CLI reference only covered branch/deploy/init/login/push/switch. Add reference pages for the commands shipped in forest-cli 5.19.0: - projects:create:demo/sql/nosql - layout:pull/diff/apply/patch - workflow:apply - environments:create/get/update/delete/reset - roles:create/apply/copy/export · users:list/invite/edit · teams:create/delete/copy-layout Pages generated from `forest <cmd> --help` (usage + arguments + options). Overview and docs.json nav updated (sub-groups: Branches & deployment, Projects, Layout, Workflows, Environments, Roles, Teams, Users). Follow-up: enrich with worked examples / prose like branch.mdx. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
… layout:diff Replaces the 23 per-command pages with 7 category pages (projects, layout, workflows, environments, roles, teams, users) and a flat CLI nav — fixes the broken links from the over-nested sidebar and removes layout:diff (not shipped). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…existing pages) Revert the category-page approach: one page per command (matching the existing branch/deploy/… pages), grouped in the sidebar (Branches & deployment, Projects, Layout, Workflows, Environments, Roles, Teams, Users) using the same nested-group pattern already used elsewhere (Connect → Data Sources). layout:diff stays out. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
New top-level tab documenting how to drive Forest with AI: - Overview — the two ways in (Claude Code plugin vs MCP) + when to use which - Claude Code — the forest plugin: install, the 4 skills (/forest:onboard/layout/workflows/management), example prompts, the vibe-coding loop - MCP — the Forest MCP server: read/write/act/understand, governed by permissions Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| Tell Claude the outcome you want, in plain language. | ||
| </Step> | ||
| <Step title="Preview"> | ||
| The skill shows the plan (and supports `--dry-run` on the underlying commands) before sending anything. |
There was a problem hiding this comment.
🟡 Medium ai/claude-code.mdx:74
The Preview step states that the skills support --dry-run on the underlying commands, but mutating commands used by these skills — such as forest layout:apply, forest roles:apply, forest users:invite, and forest projects:create:demo — have no --dry-run option. Users following the described loop for layout, management, or onboarding cannot obtain the promised no-write CLI preview and may expect a command not to make changes when it will. Consider either qualifying the claim to the commands that actually support --dry-run or documenting which steps do not offer a dry-run preview.
🚀 Reply "fix it for me" or copy this AI Prompt for your agent:
In file @ai/claude-code.mdx around line 74:
The **Preview** step states that the skills support `--dry-run` on the underlying commands, but mutating commands used by these skills — such as `forest layout:apply`, `forest roles:apply`, `forest users:invite`, and `forest projects:create:demo` — have no `--dry-run` option. Users following the described loop for layout, management, or onboarding cannot obtain the promised no-write CLI preview and may expect a command not to make changes when it will. Consider either qualifying the claim to the commands that actually support `--dry-run` or documenting which steps do not offer a dry-run preview.
Gawtier
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The CLI reference only covered
branch/deploy/init/login/push/switch. This adds reference pages for the commands shipped in forest-cli 5.19.0:projects:create:demo·create:sql·create:nosqllayout:pull·diff·apply·patchworkflow:applyenvironments:create·get·update·delete·resetroles:create·apply·copy·exportteams:create·delete·copy-layoutusers:list·invite·editHow
forest <cmd> --help(title, description, usage, arguments, options) in the existing page format.reference/cli/overview.mdxupdated: existing commands linked + new groups added.docs.jsonnav restructured into sub-groups (Branches & deployment, Projects, Layout, Workflows, Environments, Roles, Teams, Users).Review notes
--help) but light on narrative — follow-up to enrich with worked examples / prose likebranch.mdx.docs.jsonvalidated.🤖 Generated with Claude Code
Note
Add CLI reference docs for headless commands covering layout, workflows, roles, users, teams, environments, and projects
reference/cli/covering all headlessforestcommands: layout (pull/apply/patch), workflow:apply, environments (create/get/update/delete/reset), projects (create:sql/nosql/demo), roles (create/apply/copy/export), teams (create/delete/copy-layout), and users (list/invite/edit).Macroscope summarized 62dc819.