w-6ec, s-b2c, pt-a3f).
An alias is accepted anywhere a full UUID is expected, so you can copy one from any
command’s output and paste it into the next command. Resolution maps the alias back to
the UUID before the request is sent. See global flags for how
--workspace and the other id-bearing flags accept aliases.
Format
An alias is a type prefix, a hyphen, and the first three hex characters of the entity’s UUID with dashes removed.Prefix table
| Entity | Prefix | Example | Concept |
|---|---|---|---|
| Workspace | w- | w-6ec | workspace |
| Study | s- | s-b2c | study |
| Iteration | i- | i-d4e | study |
| Person | p- | p-795 | people |
| Person source | ps- | ps-1a2 | people |
| Participant | pt- | pt-a3f | people |
| Simulation config | c- | c-0b4 | |
| Job | j- | j-c17 | |
| Ask | a- | a-6ec | run vs ask |
| Ask round | r- | r-2bd | run vs ask |
| Chat endpoint | ep- | ep-9f0 | |
| Chat config | cc- | cc-5e1 | |
| Frame | f- | f-7a8 | reactions and results |
p- is the person (the reusable profile). pt- is the participant (one instance of a
person inside an iteration). They are different entities. See
people.Resolution order
Every id-bearing argument runs through one resolver. It accepts two shapes:
Anything else is a usage error. An alias whose prefix is recognized but whose entry is
not in the store exits 4 (
not_found) with the list command that would mint it, for
example ish workspace list for a w- alias. A string that is neither a UUID nor a
known alias shape exits 4 with guidance to run a list command first. See
exit codes.
Where aliases are stored
Aliases persist toaliases.json under the config root, so they survive across commands
and terminal sessions. The root is ~/.ish by default and is overridable with the
ISH_HOME environment variable. A fresh install, a deleted aliases.json, or a new
ISH_HOME starts with an empty store. When that happens, run the entity’s list command
to repopulate it.
Working with aliases
Read an alias straight out of one command and pass it to the next.--get.