feat(organizations): add CRUD commands for organizations by rexxars · Pull Request #762 · sanity-io/cli

rexxars · 2026-03-23T23:58:24Z

Description

Adds a new organizations topic to the CLI with five commands for managing organizations:

sanity organizations list - list all organizations you're a member of
sanity organizations get <organizationId> - show details of a specific organization
sanity organizations create - create a new organization (interactive or --name/--default-role flags)
sanity organizations update <organizationId> - update name, slug, or default role
sanity organizations delete <organizationId> - delete an organization (with confirmation prompt)

Hidden topic aliases so all of these also work: organization, organisations, organisation, org, orgs. Uses the two-layer alias approach from #714 (hiddenAliases on each command class + topicAliases.ts entry).

What to review

src/services/organizations.ts - extended with getOrganization, updateOrganization, deleteOrganization; createOrganization now accepts optional defaultRoleName; fixed ProjectOrganization.slug to be string | null
src/commands/organizations/ - five command files, all thin: parse flags, call service, format output
src/util/apiError.ts - shared hasStatusCode type guard to avoid as assertions in catch blocks
src/topicAliases.ts and oclif.config.js - alias wiring for the organizations topic
src/commands/organizations/__tests__/ - 23 tests across all five commands

Testing

23 unit tests covering all five commands (success, error, edge cases)
Tests use module-level client mocking (getGlobalCliClient), no service file mocks
Success tests use if (error) throw error; error tests assert toBeInstanceOf(Error) + message
All tests pass locally

Notes

--slug flag only on update, not create - the API requires the authSAML feature for slugs, which a brand-new org won't have
delete blocks server-side if the org has associated projects - the command surfaces that API error clearly
Members management commands (organizations members list/invite) are deferred pending internal discussion

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

…pe guard Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Adds `organizations update` command with --name, --slug, and --default-role flags. Includes tests for success, validation (no flags), missing arg, and API error cases. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Remove export from Organization and OrganizationDeleteResponse interfaces as they are only used internally within the service module. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Wire up topic aliases (organization, organisations, organisation, org, orgs) in topicAliases.ts and oclif.config.js. Fix linter-reported import and property ordering in org command files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

claude · 2026-03-23T23:58:38Z

Claude finished @mttdnt's task in 1m 50s —— View job

Review

Gather context
Read changed files
Identify issues
Post review

1. validateOrganizationSlug accepts invalid characters

src/actions/organizations/validateOrganizationSlug.ts:1-12 — The validator only checks for empty, uppercase, and spaces. It allows characters that are invalid in URL slugs (e.g. acme!, org_name, org.name). Slugs should be constrained to [a-z0-9-].

if (!/^[a-z0-9][a-z0-9-]*[a-z0-9]$/.test(input) && !/^[a-z0-9]$/.test(input)) {
  return 'Organization slug may only contain lowercase letters, numbers, and hyphens'
}

Fix this →

2. Misleading "User cancelled" error in delete.ts

src/commands/organizations/delete.ts:103-107 — The catch block around input() labels any thrown error as "User cancelled", but input() could throw for other reasons. The error message should pass through the actual error text rather than hardcoding "User cancelled".

} catch (error) {
  deleteOrgDebug(`User cancelled or input error`, error)
  this.error(getErrorMessage(error), {exit: 1})
}

3. Falsy check in createOrganization inconsistent with !== undefined pattern

src/services/organizations.ts:83 — defaultRoleName ? {defaultRoleName} : {} uses truthy check, so an empty string would be omitted. The rest of the codebase (command layer) uses !== undefined. Should be:

body: {name, ...(defaultRoleName !== undefined ? {defaultRoleName} : {})},

4. getOrganization passes string 'false' for boolean query params

src/services/organizations.ts:115-116 — {includeFeatures: 'false', includeMembers: 'false'} uses strings instead of booleans. If the API is type-sensitive this could return unexpected data. Use false (boolean) instead.

github-actions · 2026-03-24T00:07:12Z

Coverage Delta

File	Statements
packages/@sanity/cli/src/commands/organizations/create.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/delete.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/get.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/list.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/update.ts	100.0% (new)
packages/@sanity/cli/src/services/organizations.ts	100.0% (±0%)
packages/@sanity/cli/src/topicAliases.ts	100.0% (±0%)
packages/@sanity/cli/src/util/apiError.ts	100.0% (new)

Comparing 8 changed files against main @ 133be82f2a246f5cc1573c8e2733d50a2b2ea746

Overall Coverage

Metric	Coverage
Statements	83.2% (+ 0.2%)
Branches	72.8% (+ 0.1%)
Functions	83.3% (+ 0.1%)
Lines	83.7% (+ 0.2%)

…d patterns closer

github-actions · 2026-04-02T14:20:28Z

📦 Bundle Stats — `@sanity/cli`

Compared against main (133be82f)

`@sanity/cli`

Metric	Value	vs main (`133be82`)
Internal (raw)	2.1 KB	-
Internal (gzip)	799 B	-
Bundled (raw)	10.95 MB	-120.3 KB, -1.1%
Bundled (gzip)	2.06 MB	-20.4 KB, -1.0%
Import time	830ms	+830ms, +0.0%

`bin:sanity`

Metric	Value	vs main (`133be82`)
Internal (raw)	975 B	-
Internal (gzip)	460 B	-
Bundled (raw)	9.84 MB	-
Bundled (gzip)	1.77 MB	-
Import time	1.97s	+1.64s, +501.7% ⚠️

🗺️ View treemap · Artifacts

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

📦 Bundle Stats — `@sanity/cli-core`

Compared against main (133be82f)

Metric	Value	vs main (`133be82`)
Internal (raw)	92.3 KB	+3.2 KB, +3.5%
Internal (gzip)	21.6 KB	+822 B, +3.9%
Bundled (raw)	21.53 MB	-115.9 KB, -0.5%
Bundled (gzip)	3.41 MB	-19.7 KB, -0.6%
Import time	786ms	+786ms, +0.0%

🗺️ View treemap · Artifacts

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

📦 Bundle Stats — `create-sanity`

Compared against main (133be82f)

Metric	Value	vs main (`133be82`)
Internal (raw)	976 B	-
Internal (gzip)	507 B	-
Bundled (raw)	50.7 KB	-
Bundled (gzip)	12.6 KB	-
Import time	❌ ChildProcess denied: node	-

Details

Import time regressions over 10% are flagged with ⚠️
Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.

github-actions · 2026-04-02T14:31:50Z

Coverage Delta

File	Statements
packages/@sanity/cli/src/actions/organizations/validateOrganizationSlug.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/create.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/delete.ts	94.6% (new)
packages/@sanity/cli/src/commands/organizations/get.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/list.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/update.ts	100.0% (new)
packages/@sanity/cli/src/prompts/promptForOrganizationName.ts	100.0% (±0%)
packages/@sanity/cli/src/services/organizations.ts	100.0% (±0%)
packages/@sanity/cli/src/topicAliases.ts	100.0% (±0%)
packages/@sanity/cli/src/util/apiError.ts	100.0% (new)
packages/@sanity/cli/src/util/organizationAliases.ts	100.0% (new)

Comparing 11 changed files against main @ 7b98e0be69544a0a89ddf871219b8025128e622b

Overall Coverage

Metric	Coverage
Statements	83.3% (+ 0.2%)
Branches	73.0% (+ 0.2%)
Functions	83.4% (+ 0.1%)
Lines	83.7% (+ 0.2%)

mttdnt · 2026-04-02T14:48:01Z

packages/@sanity/cli/src/commands/organizations/list.ts

+    })
+
+    for (const {id, name, slug} of organizations) {
+      table.addRow({id, name, slug: slug ?? '-'})


Not sure if anything else is needing to be displayed

github-actions · 2026-04-02T14:54:16Z

Coverage Delta

File	Statements
packages/@sanity/cli/src/actions/organizations/validateOrganizationSlug.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/create.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/delete.ts	94.7% (new)
packages/@sanity/cli/src/commands/organizations/get.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/list.ts	100.0% (new)
packages/@sanity/cli/src/commands/organizations/update.ts	100.0% (new)
packages/@sanity/cli/src/prompts/promptForOrganizationName.ts	100.0% (±0%)
packages/@sanity/cli/src/services/organizations.ts	100.0% (±0%)
packages/@sanity/cli/src/topicAliases.ts	100.0% (±0%)
packages/@sanity/cli/src/util/apiError.ts	100.0% (new)
packages/@sanity/cli/src/util/organizationAliases.ts	100.0% (new)

Comparing 11 changed files against main @ ebc4e56198cd2071556e8687ec5f416ee2557873

Overall Coverage

Metric	Coverage
Statements	83.3% (+ 0.2%)
Branches	73.0% (+ 0.1%)
Functions	83.4% (+ 0.1%)
Lines	83.7% (+ 0.2%)

…or throwing errors

rexxars and others added 11 commits March 23, 2026 16:52

feat(organizations): extend service with get/update/delete

f028a42

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

feat(organizations): add list command

a3c9736

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

fix(organizations): slug is nullable, assert null slug renders as dash

8618656

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

feat(organizations): add get command

797ecf9

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

refactor(organizations): replace type assertion with hasStatusCode ty…

55425e8

…pe guard Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

feat(organizations): add create command

feafc0a

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

feat(organizations): add update command

3013ade

Adds `organizations update` command with --name, --slug, and --default-role flags. Includes tests for success, validation (no flags), missing arg, and API error cases. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

fix(organizations): remove duplicate success message in update command

db21856

feat(organizations): add delete command

faea743

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

fix(organizations): address lint/type/dep issues

f897e1e

Remove export from Organization and OrganizationDeleteResponse interfaces as they are only used internally within the service module. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

runeb mentioned this pull request Mar 24, 2026

feat(organizations): add sanity organizations list command #768

Closed

refactor: address pr feedback

740971e

rexxars force-pushed the feat/org-commands branch from fe45e78 to 740971e Compare March 24, 2026 21:17

feat(organizations): updating commands and tests to follow establishe…

cff21e5

…d patterns closer

feat(organizations): prompt reuse and prompt assertions

4c62462

mttdnt marked this pull request as ready for review April 2, 2026 14:47

mttdnt requested a review from a team as a code owner April 2, 2026 14:47

mttdnt requested review from gu-stav and removed request for a team April 2, 2026 14:47

mttdnt reviewed Apr 2, 2026

View reviewed changes

mttdnt requested a review from binoy14 April 2, 2026 15:00

feat(organization): changing name flag back and using error utility f…

d1048c2

…or throwing errors

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(organizations): add CRUD commands for organizations#762

feat(organizations): add CRUD commands for organizations#762
rexxars wants to merge 15 commits intomainfrom
feat/org-commands

rexxars commented Mar 23, 2026 •

edited by mttdnt

Loading

Uh oh!

claude bot commented Mar 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 24, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

mttdnt Apr 2, 2026

Uh oh!

github-actions bot commented Apr 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

rexxars commented Mar 23, 2026 • edited by mttdnt Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What to review

Testing

Notes

Uh oh!

claude bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review

Uh oh!

github-actions bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Delta

Overall Coverage

Uh oh!

github-actions bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle Stats — @sanity/cli

@sanity/cli

bin:sanity

📦 Bundle Stats — @sanity/cli-core

📦 Bundle Stats — create-sanity

Uh oh!

github-actions bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Delta

Overall Coverage

Uh oh!

mttdnt Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 2, 2026

Coverage Delta

Overall Coverage

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rexxars commented Mar 23, 2026 •

edited by mttdnt

Loading

claude bot commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 24, 2026 •

edited

Loading

github-actions bot commented Apr 2, 2026 •

edited

Loading

📦 Bundle Stats — `@sanity/cli`

`@sanity/cli`

`bin:sanity`

📦 Bundle Stats — `@sanity/cli-core`

📦 Bundle Stats — `create-sanity`

github-actions bot commented Apr 2, 2026 •

edited

Loading