From fad27c4ee8c7d2f92a0026d1d2112c7bf1ee8fbb Mon Sep 17 00:00:00 2001 From: Gautier Delache Date: Fri, 17 Jul 2026 13:44:29 +0200 Subject: [PATCH 1/4] docs(cli): document the headless commands (projects/layout/workflow/roles/users/teams/environments) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --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) --- docs.json | 69 +++++++++++++++++++++++-- reference/cli/environments-create.mdx | 26 ++++++++++ reference/cli/environments-delete.mdx | 27 ++++++++++ reference/cli/environments-get.mdx | 27 ++++++++++ reference/cli/environments-reset.mdx | 23 +++++++++ reference/cli/environments-update.mdx | 23 +++++++++ reference/cli/layout-apply.mdx | 31 +++++++++++ reference/cli/layout-diff.mdx | 15 ++++++ reference/cli/layout-patch.mdx | 31 +++++++++++ reference/cli/layout-pull.mdx | 25 +++++++++ reference/cli/overview.mdx | 52 +++++++++++++++++-- reference/cli/projects-create-demo.mdx | 29 +++++++++++ reference/cli/projects-create-nosql.mdx | 38 ++++++++++++++ reference/cli/projects-create-sql.mdx | 39 ++++++++++++++ reference/cli/roles-apply.mdx | 29 +++++++++++ reference/cli/roles-copy.mdx | 23 +++++++++ reference/cli/roles-create.mdx | 22 ++++++++ reference/cli/roles-export.mdx | 23 +++++++++ reference/cli/teams-copy-layout.mdx | 24 +++++++++ reference/cli/teams-create.mdx | 22 ++++++++ reference/cli/teams-delete.mdx | 23 +++++++++ reference/cli/users-edit.mdx | 26 ++++++++++ reference/cli/users-invite.mdx | 26 ++++++++++ reference/cli/users-list.mdx | 22 ++++++++ reference/cli/workflow-apply.mdx | 31 +++++++++++ 25 files changed, 718 insertions(+), 8 deletions(-) create mode 100644 reference/cli/environments-create.mdx create mode 100644 reference/cli/environments-delete.mdx create mode 100644 reference/cli/environments-get.mdx create mode 100644 reference/cli/environments-reset.mdx create mode 100644 reference/cli/environments-update.mdx create mode 100644 reference/cli/layout-apply.mdx create mode 100644 reference/cli/layout-diff.mdx create mode 100644 reference/cli/layout-patch.mdx create mode 100644 reference/cli/layout-pull.mdx create mode 100644 reference/cli/projects-create-demo.mdx create mode 100644 reference/cli/projects-create-nosql.mdx create mode 100644 reference/cli/projects-create-sql.mdx create mode 100644 reference/cli/roles-apply.mdx create mode 100644 reference/cli/roles-copy.mdx create mode 100644 reference/cli/roles-create.mdx create mode 100644 reference/cli/roles-export.mdx create mode 100644 reference/cli/teams-copy-layout.mdx create mode 100644 reference/cli/teams-create.mdx create mode 100644 reference/cli/teams-delete.mdx create mode 100644 reference/cli/users-edit.mdx create mode 100644 reference/cli/users-invite.mdx create mode 100644 reference/cli/users-list.mdx create mode 100644 reference/cli/workflow-apply.mdx diff --git a/docs.json b/docs.json index 29b1f58..5fe0f52 100644 --- a/docs.json +++ b/docs.json @@ -343,10 +343,71 @@ "reference/cli/overview", "reference/cli/init", "reference/cli/login", - "reference/cli/branch", - "reference/cli/push", - "reference/cli/deploy", - "reference/cli/switch" + { + "group": "Branches & deployment", + "pages": [ + "reference/cli/branch", + "reference/cli/switch", + "reference/cli/push", + "reference/cli/deploy" + ] + }, + { + "group": "Projects", + "pages": [ + "reference/cli/projects-create-demo", + "reference/cli/projects-create-sql", + "reference/cli/projects-create-nosql" + ] + }, + { + "group": "Layout", + "pages": [ + "reference/cli/layout-pull", + "reference/cli/layout-diff", + "reference/cli/layout-apply", + "reference/cli/layout-patch" + ] + }, + { + "group": "Workflows", + "pages": ["reference/cli/workflow-apply"] + }, + { + "group": "Environments", + "pages": [ + "reference/cli/environments-create", + "reference/cli/environments-get", + "reference/cli/environments-update", + "reference/cli/environments-delete", + "reference/cli/environments-reset" + ] + }, + { + "group": "Roles", + "pages": [ + "reference/cli/roles-create", + "reference/cli/roles-apply", + "reference/cli/roles-copy", + "reference/cli/roles-export" + ] + }, + { + "group": "Teams", + "pages": [ + "reference/cli/teams-create", + "reference/cli/teams-delete", + "reference/cli/teams-copy-layout" + ] + }, + { + "group": "Users", + "pages": [ + "reference/cli/users-list", + "reference/cli/users-invite", + "reference/cli/users-edit" + ] + } ] }, { diff --git a/reference/cli/environments-create.mdx b/reference/cli/environments-create.mdx new file mode 100644 index 0000000..6a3290a --- /dev/null +++ b/reference/cli/environments-create.mdx @@ -0,0 +1,26 @@ +--- +title: forest environments:create +description: "Create a new environment" +--- + +# forest environments:create + +Create a new environment. + +## Usage + +```bash +forest environments:create [options] +``` + +## Options + +| Option | Description | +|---|---| +| `-f, --format=