Skip to content

feat: show coder sharing in CLI help and reference docs - #30141

Merged
nickvigilante merged 3 commits into
mainfrom
vigilante/cli-22-coder-sharing-unhide-the-command-now-that-shared-workspaces
Sep 30, 2026
Merged

nickvigilante merged 3 commits into
mainfrom
vigilante/cli-22-coder-sharing-unhide-the-command-now-that-shared-workspaces

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

coder sharing has been hidden since it was added behind an experiment, although Shared Workspaces is GA and the prose docs already use it.

This removes Hidden: true, regenerates docs/reference/cli/sharing/*, and adds the pages to the docs manifest.
The shared workspaces guide and the persistent shared workspaces tutorial now link to the new reference.

Behavior change: coder sharing and its subcommands now appear in coder --help.
The commands themselves are unchanged.
The sharing remove --user/--group help text previously said "to share the workspace with"; it now says "to remove from the workspace".

Decisions
  • Follow-up not in this PR: DELETE /workspaces/{workspace}/acl has no CLI caller.

Closes CLI-22

This PR was generated by Coder Agents on behalf of @nickvigilante.

@linear-code

linear-code Bot commented Sep 30, 2026

Copy link
Copy Markdown

CLI-22

@nickvigilante
nickvigilante marked this pull request as ready for review September 30, 2026 00:37
@coderagents

coderagents Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Documentation Check

Updates Needed

  • docs/user-guides/shared-workspaces.md (open) - The CLI section now links the new reference index ("For full command details, see coder sharing"), matching the coder secret pattern in docs/user-guides/user-secrets.md.
  • docs/tutorials/persistent-shared-workspaces.md (open) - Now links the reference index after the "Verify current sharing status" block ("For every subcommand and flag, see the coder sharing reference").

Automated review via Coder Agents

@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

@matifali
matifali requested a review from aslilac September 30, 2026 05:00

@matifali matifali left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we mention that this will not work if Sharing is disabled on the deployment and link to those admin docs?
@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-30T05:05:09.576781Z 4e345fe Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4e345fea65

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/reference/cli/sharing/index.md Resolved
@nickvigilante

Copy link
Copy Markdown
Collaborator Author

Should we mention that this will not work if Sharing is disabled on the deployment and link to those admin docs?

Yes we should, and I'll make that tweak!

@nickvigilante

Copy link
Copy Markdown
Collaborator Author

@matifali Added in 37d6b56: coder sharing add and remove now say they fail when sharing is disabled (deployment-wide or by org policy) and link to https://coder.com/docs/user-guides/shared-workspaces#policies, which covers the Disabled policy and CODER_DISABLE_WORKSPACE_SHARING. The generated reference pages pick this up. I left status alone since it still works when sharing is disabled.

Generated by Coder Agents on behalf of @nickvigilante.

@aslilac aslilac 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.

lol oops. that's a little embarrassing.

`coder sharing` has been hidden since it was added behind an experiment,
although Shared Workspaces is GA and the prose docs already use it.

Linear: CLI-22
Now that coder sharing has generated reference pages, point the
shared workspaces guide and the persistent shared workspaces tutorial
at them.

Linear: CLI-22
Both subcommands update the workspace ACL, which fails when workspace
sharing is disabled for the deployment or the organization's sharing
policy doesn't allow it. The status subcommand only reads the ACL and
isn't affected, so it has no note.
@nickvigilante
nickvigilante force-pushed the vigilante/cli-22-coder-sharing-unhide-the-command-now-that-shared-workspaces branch from 37d6b56 to e370e77 Compare September 30, 2026 19:24
@nickvigilante
nickvigilante enabled auto-merge (squash) September 30, 2026 19:24
@nickvigilante
nickvigilante merged commit 0d12256 into main Sep 30, 2026
52 of 54 checks passed
@nickvigilante
nickvigilante deleted the vigilante/cli-22-coder-sharing-unhide-the-command-now-that-shared-workspaces branch September 30, 2026 21:29
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 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.

3 participants