Skip to main content

ish ask run

Run an ask - append a round to the active ask, or --new to create a fresh ask Usage: ish ask run [id] [options]

Arguments

Ask alias or UUID to append to (defaults to active ask; ignored with —new) (optional)

Options

string
Ask ID; alternative to positional argument
boolean
Create a new ask instead of appending a round
string
Ask name (with —new; auto-generated if omitted)
string
Ask description (with —new only)
string
Workspace ID (with —new only)
string
Round prompt - what participants respond to Required.
string
Variant: text:”…”, ./file.png, image:./file.png, ./file.png::label=B (repeatable) Default: [].
string
JSON manifest of variants (alternative to —variant)
boolean
Each participant picks a favourite variant (compatible with —wants-ratings; can be set together).
boolean
Each participant rates every variant 1-5 (compatible with —wants-pick; can be set together). If neither is set, participants leave a free-form comment only.
string
Questions as inline JSON, @file, or a JSON file path: [{“question”:”…”,“type”:“text”|“slider”|“likert”|“single-choice”|“multiple-choice”|“number”}]
string
2-letter language code (with —new only) Default: “en”.
string
Person IDs/aliases (comma-separated or repeatable) Default: [].
string
Randomly sample N people from the matching pool (max 20 per dispatch - split into multiple slices for larger cohorts)
boolean
Use every simulatable AI person matching the filters (with —new only) (capped at 20 per dispatch - split into multiple slices for larger cohorts)
string
Substring match against person name
string
Substring match against person bio
string
Substring match against person occupation (repeatable) Default: [].
string
Filter by gender (female, male, nonbinary; repeatable, OR semantics) Default: [].
string
Filter by 2-letter country code (repeatable) Default: [].
string
Minimum age (inclusive)
string
Maximum age (inclusive)
string
Filter by visibility: workspace (your workspace), shared (community-published), platform (admin-curated). Old values private / public are accepted and mapped to workspace / platform.
string
Drill-in subset (Pattern B) - append-round only. 1-indexed prior round to filter against. Pair with —subset-variant.
string
Drill-in subset (Pattern B) - append-round only. Variant id (UUID) on the prior round whose pickers should inherit. Read from aggregates.pick_buckets or variants[*].id on the prior round’s ask results --json.
boolean
Wait until the round completes (or errors)
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)

ish ask list

List asks for a workspace Usage: ish ask list [options]

Options

string
Workspace ID
boolean
Include archived asks alongside active ones (default: active only).

ish ask create

Create a new ask with a first round and dispatch to people Usage: ish ask create [options]

Options

string
Workspace ID
string
Ask name Required.
string
Ask description
string
Round prompt - what participants respond to Required.
string
Variant: text:”…”, ./file.png, image:./file.png, ./file.png::label=B (repeatable) Default: [].
string
JSON manifest of variants (alternative to —variant)
boolean
Each participant picks a favourite variant (compatible with —wants-ratings; can be set together).
boolean
Each participant rates every variant 1-5 (compatible with —wants-pick; can be set together). If neither is set, participants leave a free-form comment only.
string
Questions as inline JSON, @file, or a JSON file path: [{“question”:”…”,“type”:“text”|“slider”|“likert”|“single-choice”|“multiple-choice”|“number”}]
string
2-letter language code Default: “en”.
string
Person IDs/aliases (comma-separated or repeatable) Default: [].
string
Randomly sample N people from the matching pool (max 20 per dispatch - split into multiple slices for larger cohorts)
boolean
Use every simulatable AI person matching the filters (capped at 20 per dispatch - split into multiple slices for larger cohorts)
string
Substring match against person name
string
Substring match against person bio
string
Substring match against person occupation (repeatable) Default: [].
string
Filter by gender (female, male, nonbinary; repeatable, OR semantics) Default: [].
string
Filter by 2-letter country code (repeatable) Default: [].
string
Minimum age (inclusive)
string
Maximum age (inclusive)
string
Filter by visibility: workspace (your workspace), shared (community-published), platform (admin-curated). Old values private / public are accepted and mapped to workspace / platform.
boolean
Create the ask in DRAFT status without billing or dispatching the round. Hand the draft id back to the user, then start it with ish ask dispatch <id>. People flags are still required because the participants are materialized at create time. Mutually exclusive with —wait (nothing to wait for).
boolean
Wait until the first round completes (or errors)
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)

ish ask dispatch

Dispatch a draft ask - draws credits and starts the round Usage: ish ask dispatch [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
boolean
Wait until the first round completes (or errors)
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask get

Get full ask detail (accepts multiple IDs for batched lookup) Usage: ish ask get [ids]... [options]

Arguments

Ask alias(es)/UUID(s); defaults to active ask from ish ask use (optional, variadic)

Options

string
Ask ID; alternative to a single positional argument
string
Show only round N (1-indexed); single-ask only
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask results

Show aggregated results (picks, mean ratings, comments, summary) Usage: ish ask results [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Show only round N (1-indexed; default: all rounds)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask wait

Poll until a round is completed (or errored) Usage: ish ask wait [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Round number to wait for (1-indexed; default: last round)
string
Max seconds to wait (default 300)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask add-round

Append a new round to an existing ask (max 5 per ask) Usage: ish ask add-round [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Workspace ID; accepted for consistency (workspace is inferred from the ask)
string
Round prompt Required.
string
Variant flag (repeatable; same syntax as ask create) Default: [].
string
JSON manifest of variants
boolean
Each participant picks a favourite variant (compatible with —wants-ratings; can be set together).
boolean
Each participant rates every variant 1-5 (compatible with —wants-pick; can be set together). If neither is set, participants leave a free-form comment only.
string
Questions as inline JSON, @file, or a JSON file path: [{“question”:”…”,“type”:“text”|“slider”|“likert”|“single-choice”|“multiple-choice”|“number”}]
string
Drill-in subset (Pattern B) - 1-indexed prior round to filter against. Pair with —subset-variant. The new round dispatches only to participants who picked —subset-variant on round N.
string
Drill-in subset (Pattern B) - variant id (UUID) on the prior round whose pickers should inherit. Pair with —subset-round. Read from aggregates.pick_buckets or variants[*].id on the prior round.
boolean
Wait until the new round completes
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)

ish ask add-questions

Append questionnaire questions to a round. Default: additive re-dispatch (prior picks/comments/ratings preserved; only the new questions are answered). Pass —redispatch-all to fully reset and re-run the round from scratch. Usage: ish ask add-questions [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Round number (1-indexed) or round id/alias Required.
string
Questions as inline JSON, @file, or a JSON file path: [{“question”:”…”,“type”:“text”|“slider”|“likert”|“single-choice”|“multiple-choice”|“number”}] Required.
boolean
Clear prior phase-1 outputs (comment, pick, ratings) and re-run the entire round from scratch (legacy behavior). Default is additive - only the new questions are answered.
boolean
Wait until the round completes (or errors)
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask retry

Re-dispatch only the errored responses on a round (idempotent: zero-errored is a no-op). Usage: ish ask retry [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Round number (1-indexed) or round id/alias Required.
boolean
Wait until the retried round completes (or errors)
string
Wait timeout in seconds (default 300)
boolean
Skip the credit-spend confirmation (required in —json / non-TTY to proceed)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask add-people

Add people to an existing ask (they become participants when the round runs; optionally backfill prior rounds) Usage: ish ask add-people [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Workspace ID; accepted for consistency (workspace is inferred from the ask)
string
Round to add people to (required) Required.
string
Person IDs/aliases (comma-separated or repeatable) Default: [].
string
Randomly sample N people from the matching pool (max 20 per dispatch - split into multiple slices for larger cohorts)
boolean
Add every simulatable AI person matching the filters not already included (capped at 20 per dispatch - split into multiple slices for larger cohorts)
string
Substring match against person name
string
Substring match against person bio
string
Substring match against person occupation (repeatable) Default: [].
string
Filter by gender (female, male, nonbinary; repeatable, OR semantics) Default: [].
string
Filter by 2-letter country code (repeatable) Default: [].
string
Minimum age (inclusive)
string
Maximum age (inclusive)
string
Filter by visibility: workspace (your workspace), shared (community-published), platform (admin-curated). Old values private / public are accepted and mapped to workspace / platform.
boolean
Backfill prior rounds in order for new people

ish ask update

Update an ask’s name or description Usage: ish ask update [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
New name
string
New description
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask archive

Archive an ask (hides it from default list) Usage: ish ask archive [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask unarchive

Restore an archived ask Usage: ish ask unarchive [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask delete

Delete an ask and all its rounds, responses, and participants Usage: ish ask delete [id] [options]

Arguments

Ask alias or UUID (defaults to active ask) (optional)

Options

string
Ask ID; alternative to positional argument
boolean
Skip confirmation prompt (required in —json or non-TTY contexts)
string
Workspace ID; accepted for consistency (inferred from alias / active context)

ish ask use

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

Arguments

Ask alias or UUID (optional)

Options

boolean
Remove the active ask from config
string
Workspace ID; accepted for consistency (inferred from alias / active context)

Global flags

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