Opening commands: create, get, list
The Opening Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Opening, one group of Opening commands.
Opening.create
Creates an Opening. Verb page.
npx startup-builder do Opening.create --json '<input>' [--try | --send | --do]Emits Opening.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
role | Role | required | The Role the Human joins, by taking a share of it. |
kind | string | required | One of floor, contractor, employee, or cofounder. |
reason | string | required | One of floor, credential, edge, relationship, capital, capacity, or distribution. |
hypothesis | Hypothesis | required | The result a hire must beat the incumbent Agent on. |
skills | list of Skill | The Skills required, each citing the Evidence that shows the gap. | |
credentials | list of Credential | The Credentials a Reserved Act in the Role requires. | |
commitment | string | Hours per week, from a few hours to full time. | |
terms | url | The published terms for this kind of Opening. | |
listed | boolean | True once the Opening is public; unlisted Openings reach only the talent pool. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
opening | Opening | required | The Opening. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Opening.create --json '{"role":Opening.get
Returns one Opening by id. Verb page.
npx startup-builder do Opening.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Opening. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
opening | Opening | required | The Opening. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Opening.get --json '{"id":Opening.list
Returns Openings, newest first, one page at a time. Verb page.
npx startup-builder do Opening.list --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
openings | list of Opening | required | One page of Openings. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Opening.list --json '{"limit":