Skip to main content

ish workspace list

List all workspaces Usage: ish workspace list

ish workspace create

Create a new workspace (or reuse an existing one with —ensure) Usage: ish workspace create [options]

Options

--name <name>
string
Workspace name Required.
--description <description>
string
Workspace description
--base-url <url>
string
Default base URL
--ensure
boolean
Idempotent: if a workspace with this exact name already exists in the caller’s account, return it instead of creating. Useful on saturated accounts where create would 402/usage_limit_reached.

ish workspace get

Get workspace details Usage: ish workspace get <id>

Arguments

id
Workspace ID (required)

ish workspace update

Update a workspace Usage: ish workspace update <id> [options]

Arguments

id
Workspace ID (required)

Options

--name <name>
string
Workspace name
--description <description>
string
Workspace description
--base-url <url>
string
Default base URL
--logo <url>
string
Brand logo image URL (shown on the workspace and on shared study links)

ish workspace delete

Delete a workspace (and ALL nested studies, asks, people, secrets, configs, sources, chat endpoints) Usage: ish workspace delete <id> [options]

Arguments

id
Workspace ID (required)

Options

-y, --yes
boolean
Skip confirmation prompt (required in —json or non-TTY contexts)

ish workspace site-access

Manage credentials for gated test sites (basic auth, session cookie, login form) Usage: ish workspace site-access

ish workspace site-access status

Show which site-access methods are configured Usage: ish workspace site-access status [options]

Options

--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace site-access basic-auth

Set HTTP basic auth credentials Usage: ish workspace site-access basic-auth [options]

Options

--username <u>
string
Username (or ”-” to read from stdin) Required.
--password <p>
string
Password (or ”-” to read from stdin) Required.
--origin <url>
string
Origin to bind credentials to; defaults to workspace base_url
--workspace <id>
string
Workspace ID; defaults to active workspace
Set a session cookie for sites that gate on a token (Vercel preview, Lovable, etc.) Usage: ish workspace site-access cookie [options]

Options

--name <n>
string
Cookie name Required.
--value <v>
string
Cookie value (or ”-” to read from stdin) Required.
--origin <url>
string
Origin to bind cookie to; defaults to workspace base_url
--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace site-access login

Set login form credentials a participant will type into the site Usage: ish workspace site-access login [options]

Options

--username <u>
string
Username (or ”-” to read from stdin) Required.
--password <p>
string
Password (or ”-” to read from stdin) Required.
--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace site-access affirm-public

Mark the site as not requiring credentials Usage: ish workspace site-access affirm-public [options]

Options

--origin <url>
string
Origin to mark public; defaults to workspace base_url
--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace site-access clear

Clear configured site-access credentials Usage: ish workspace site-access clear <method> [options]

Arguments

method
basic-auth | cookie | login | public | all (required)

Options

--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace info

Show workspace details + plan-limit usage counters Usage: ish workspace info [options]

Options

--workspace <id>
string
Workspace ID; defaults to active workspace

ish workspace use

Set the active workspace (saved to ~/.ish/config.json) Usage: ish workspace use [id] [options]

Arguments

id
Workspace alias or UUID (optional)

Options

--clear
boolean
Remove the active workspace from config

Global flags

Every command accepts the global flags.
-V, --version
boolean
output the version number
-t, --token <token>
string
Auth token (or set ISH_TOKEN env var)
--token-file <path>
string
Read auth token from a file (preferred over —token / ISH_TOKEN)
--workspace <id>
string
Default workspace ID; per-subcommand —workspace overrides
--json
boolean
Output as JSON (auto-enabled when piped)
--get <field>
string
Extract a single field from the JSON response and print only its value (implies —json internally; supports dotted paths e.g. person.name)
--human
boolean
Force human-readable output even when stdout is piped (overrides JSON-when-piped auto-detection)
--fields <fields>
string
Comma-separated fields to include in JSON output (e.g. alias,name,status)
--verbose
boolean
Include full UUIDs and timestamps in JSON output
--no-color
boolean
Disable colored output (also honored: NO_COLOR env var)
-q, --quiet
boolean
Suppress progress messages on stderr (no-op for read commands that emit none)