CLI¶
Every command ceres accepts. The table commands near the end have no hand-written
declaration at all, their whole surface being generated from the entity definitions,
so a table's flags and the filter keys it serves can never disagree.
Every command takes the global options, and an address argument accepts all, a
component address, or a selector matching several.
Global Options¶
| Option | Required | Description |
|---|---|---|
--version |
Show the current Ceres version number and exit. | |
--config PATH |
Use a specific Ceres configuration file, possibly outside the current working directory. | |
--color |
Enable colorized output. | |
--no-color |
Disable colorized output. |
Commands¶
ceres run¶
Start the engine as a foreground process.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
Addresses of components to run on startup. | |
--watch |
Automatically restart the engine on code changes. |
ceres check¶
Validate project configuration (ceres.yaml) for errors.
ceres reload¶
Apply configuration changes.
ceres status¶
Show engine and component statuses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
Addresses of components to show the status of. |
ceres start¶
Start components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to start. |
ceres stop¶
Stop components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to stop. |
ceres enable¶
Enable components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to enable. |
ceres disable¶
Disable components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to disable. |
ceres up¶
Start and enable components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to start and enable. |
ceres down¶
Stop and disable components at the provided addresses.
| Option | Required | Description |
|---|---|---|
<ADDRESSES> |
yes | Addresses of components to stop and disable. |
ceres console¶
Commands for interacting with a project's web console.
ceres console open¶
Open the project's web console in a browser.
ceres console url¶
Write the project's web console URL to stdout.
ceres service¶
Manage a user-level SystemD or LaunchD background service for this project.
ceres service generate¶
Generate a service definition file for this project.
| Option | Required | Description |
|---|---|---|
<PATH> |
File path to write to. Standard output is used if not specified. |
ceres service start¶
Start the background service, creating and/or updating the service file as needed.
ceres service stop¶
Stop the background service, deleting the service file afterwards.
ceres service status¶
Show the status of the background service.
ceres database¶
Manage the project database.
ceres database ddl¶
Show DDL commands used to initialize the database.
ceres database shell¶
Open an interactive database shell (psql or sqlite3) for the project database.
ceres database clear¶
Remove all data from the database. Tables and indexes are not removed, only truncated.
ceres database migrate¶
Apply pending database migrations.
| Option | Required | Description |
|---|---|---|
--yes |
Apply without prompting for confirmation. |
ceres database migrations¶
Show applied and pending database migrations.
ceres generate¶
Generate various project resources.
ceres generate openapi¶
Generate up-to-date OpenAPI schema for the Ceres Rest API.
| Option | Required | Description |
|---|---|---|
--output PATH |
File path to write to. Standard output is used if not specified. | |
--format FORMAT |
The output format. | |
--indent INDENT |
Indentation width for JSON output. |
ceres generate certificate¶
Issue the HTTPS certificate and key, signed by a certificate authority.
| Option | Required | Description |
|---|---|---|
--ip ADDRESS |
An extra IP address for the certificate to name. Repeatable. | |
--dns NAME |
An extra DNS name for the certificate to name. Repeatable. | |
--days DAYS |
Days the certificate stays valid, at most 825. Defaults to auto.days, or 365. |
|
--force |
Replace the certificate and key even when they are current. |
ceres alerts¶
Manage alerts.
ceres alerts select¶
Retrieve alerts.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres alerts count¶
Count alerts.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres alerts any¶
Check whether any alerts match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres alerts create¶
Create a alert.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The alert's id. | |
--address VALUE |
The alert's address. | |
--timestamp VALUE |
The alert's timestamp. | |
--level VALUE |
The alert's level. | |
--type VALUE |
The alert's type. | |
--data VALUE |
The alert's data. |
ceres alerts update¶
Update alerts, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres alerts delete¶
Delete alerts, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres alerts load¶
Load alerts from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read alerts from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres alerts follow¶
Follow new alerts as they arrive.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only alerts with this id. Repeat to match any of several. | |
--address VALUE |
Only alerts with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only alerts with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only alerts recorded at or after this time. | |
--before VALUE |
Only alerts recorded before this time. | |
--timespan VALUE |
Only alerts inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only alerts newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only alerts older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only alerts recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only alerts recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only alerts recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only alerts recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only alerts with this level. Repeat to match any of several. | |
--min-level VALUE |
Only alerts whose level is at or above this. | |
--max-level VALUE |
Only alerts whose level is at or below this. | |
--type VALUE |
Only alerts with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only alerts whose type contains this. | |
--type-prefix VALUE |
Only alerts whose type starts with this. | |
--type-suffix VALUE |
Only alerts whose type ends with this. | |
--data-contains VALUE |
Only alerts whose data contains this. | |
--data-prefix VALUE |
Only alerts whose data starts with this. | |
--data-suffix VALUE |
Only alerts whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many alerts. | |
--offset VALUE |
Skip this many alerts before returning any. | |
--or VALUE |
Only alerts matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only alerts matching all of these subfilters, as a JSON or YAML list. |
ceres logs¶
Manage logs.
ceres logs select¶
Retrieve logs.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres logs count¶
Count logs.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres logs any¶
Check whether any logs match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres logs create¶
Create a log entry.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The log entry's id. | |
--address VALUE |
The log entry's address. | |
--timestamp VALUE |
The log entry's timestamp. | |
--level VALUE |
The log entry's level. | |
--content VALUE |
The log entry's content. |
ceres logs update¶
Update logs, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres logs delete¶
Delete logs, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres logs load¶
Load logs from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read logs from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres logs follow¶
Follow new logs as they arrive.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only logs with this id. Repeat to match any of several. | |
--address VALUE |
Only logs with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only logs with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only logs recorded at or after this time. | |
--before VALUE |
Only logs recorded before this time. | |
--timespan VALUE |
Only logs inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only logs newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only logs older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only logs recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only logs recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only logs recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only logs recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--level VALUE |
Only logs with this level. Repeat to match any of several. | |
--min-level VALUE |
Only logs whose level is at or above this. | |
--max-level VALUE |
Only logs whose level is at or below this. | |
--content VALUE |
Only logs with this content. Repeat to match any of several. | |
--contains VALUE |
Only logs whose content contains this. | |
--prefix VALUE |
Only logs whose content starts with this. | |
--suffix VALUE |
Only logs whose content ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many logs. | |
--offset VALUE |
Skip this many logs before returning any. | |
--or VALUE |
Only logs matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only logs matching all of these subfilters, as a JSON or YAML list. |
ceres messages¶
Manage messages.
ceres messages select¶
Retrieve messages.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres messages count¶
Count messages.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres messages any¶
Check whether any messages match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres messages create¶
Create a message.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The message's id. | |
--address VALUE |
The message's address. | |
--timestamp VALUE |
The message's timestamp. | |
--connection VALUE |
The message's connection. | |
--direction VALUE |
The message's direction. | |
--data VALUE |
The message's data. |
ceres messages update¶
Update messages, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres messages delete¶
Delete messages, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres messages load¶
Load messages from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read messages from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres messages follow¶
Follow new messages as they arrive.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only messages with this id. Repeat to match any of several. | |
--address VALUE |
Only messages with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only messages with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only messages recorded at or after this time. | |
--before VALUE |
Only messages recorded before this time. | |
--timespan VALUE |
Only messages inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only messages newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only messages older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only messages recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only messages recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only messages recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only messages recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only messages with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only messages whose connection contains this. | |
--connection-prefix VALUE |
Only messages whose connection starts with this. | |
--connection-suffix VALUE |
Only messages whose connection ends with this. | |
--direction VALUE |
Only messages with this direction. Repeat to match any of several. | |
--data VALUE |
Only messages with this data. Repeat to match any of several. | |
--contains VALUE |
Only messages whose data contains this. | |
--prefix VALUE |
Only messages whose data starts with this. | |
--suffix VALUE |
Only messages whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many messages. | |
--offset VALUE |
Skip this many messages before returning any. | |
--or VALUE |
Only messages matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only messages matching all of these subfilters, as a JSON or YAML list. |
ceres particles¶
Manage particles.
ceres particles select¶
Retrieve particles.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres particles count¶
Count particles.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres particles any¶
Check whether any particles match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres particles create¶
Create a particle.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The particle's id. | |
--address VALUE |
The particle's address. | |
--timestamp VALUE |
The particle's timestamp. | |
--connection VALUE |
The particle's connection. | |
--type VALUE |
The particle's type. | |
--data VALUE |
The particle's data. |
ceres particles update¶
Update particles, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres particles delete¶
Delete particles, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres particles load¶
Load particles from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read particles from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres particles follow¶
Follow new particles as they arrive.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only particles with this id. Repeat to match any of several. | |
--address VALUE |
Only particles with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--timestamp VALUE |
Only particles with this timestamp. Repeat to match any of several. | |
--after VALUE |
Only particles recorded at or after this time. | |
--before VALUE |
Only particles recorded before this time. | |
--timespan VALUE |
Only particles inside this span, as two times or a time and a duration. | |
--max-age VALUE |
Only particles newer than this, as a duration like 2h or P1D. |
|
--min-age VALUE |
Only particles older than this, as a duration like 2h or P1D. |
|
--after-hour VALUE |
Only particles recorded at or after this hour of the day, whatever the date. | |
--before-hour VALUE |
Only particles recorded before this hour of the day, whatever the date. | |
--after-minute VALUE |
Only particles recorded at or after this minute of the day, whatever the date. | |
--before-minute VALUE |
Only particles recorded before this minute of the day, whatever the date. | |
--subsample-every VALUE |
Thin the result, keeping one row per interval. | |
--subsample VALUE |
Thin the result, keeping one row per interval. | |
--subsample-select VALUE |
Thin the result, keeping one row per interval. | |
--connection VALUE |
Only particles with this connection. Repeat to match any of several. | |
--connection-contains VALUE |
Only particles whose connection contains this. | |
--connection-prefix VALUE |
Only particles whose connection starts with this. | |
--connection-suffix VALUE |
Only particles whose connection ends with this. | |
--type VALUE |
Only particles with this type. Repeat to match any of several. | |
--type-contains VALUE |
Only particles whose type contains this. | |
--type-prefix VALUE |
Only particles whose type starts with this. | |
--type-suffix VALUE |
Only particles whose type ends with this. | |
--data-contains VALUE |
Only particles whose data contains this. | |
--data-prefix VALUE |
Only particles whose data starts with this. | |
--data-suffix VALUE |
Only particles whose data ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many particles. | |
--offset VALUE |
Skip this many particles before returning any. | |
--or VALUE |
Only particles matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only particles matching all of these subfilters, as a JSON or YAML list. |
ceres settings¶
Manage settings.
ceres settings select¶
Retrieve settings.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only settings with this user-id. Repeat to match any of several. | |
--name VALUE |
Only settings with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only settings whose name contains this. | |
--name-prefix VALUE |
Only settings whose name starts with this. | |
--name-suffix VALUE |
Only settings whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many settings. | |
--offset VALUE |
Skip this many settings before returning any. | |
--or VALUE |
Only settings matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only settings matching all of these subfilters, as a JSON or YAML list. |
ceres settings count¶
Count settings.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only settings with this user-id. Repeat to match any of several. | |
--name VALUE |
Only settings with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only settings whose name contains this. | |
--name-prefix VALUE |
Only settings whose name starts with this. | |
--name-suffix VALUE |
Only settings whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many settings. | |
--offset VALUE |
Skip this many settings before returning any. | |
--or VALUE |
Only settings matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only settings matching all of these subfilters, as a JSON or YAML list. |
ceres settings any¶
Check whether any settings match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only settings with this user-id. Repeat to match any of several. | |
--name VALUE |
Only settings with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only settings whose name contains this. | |
--name-prefix VALUE |
Only settings whose name starts with this. | |
--name-suffix VALUE |
Only settings whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many settings. | |
--offset VALUE |
Skip this many settings before returning any. | |
--or VALUE |
Only settings matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only settings matching all of these subfilters, as a JSON or YAML list. |
ceres settings create¶
Create a setting.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
yes | The setting's user-id. |
--name VALUE |
yes | The setting's name. |
--value VALUE |
yes | The setting's value. |
ceres settings update¶
Update settings, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only settings with this user-id. Repeat to match any of several. | |
--name VALUE |
Only settings with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only settings whose name contains this. | |
--name-prefix VALUE |
Only settings whose name starts with this. | |
--name-suffix VALUE |
Only settings whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many settings. | |
--offset VALUE |
Skip this many settings before returning any. | |
--or VALUE |
Only settings matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only settings matching all of these subfilters, as a JSON or YAML list. |
ceres settings delete¶
Delete settings, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only settings with this user-id. Repeat to match any of several. | |
--name VALUE |
Only settings with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only settings whose name contains this. | |
--name-prefix VALUE |
Only settings whose name starts with this. | |
--name-suffix VALUE |
Only settings whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many settings. | |
--offset VALUE |
Skip this many settings before returning any. | |
--or VALUE |
Only settings matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only settings matching all of these subfilters, as a JSON or YAML list. |
ceres settings load¶
Load settings from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read settings from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres users¶
Manage users.
ceres users select¶
Retrieve users.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only users with this id. Repeat to match any of several. | |
--username VALUE |
Only users with this username. Repeat to match any of several. | |
--username-contains VALUE |
Only users whose username contains this. | |
--username-prefix VALUE |
Only users whose username starts with this. | |
--username-suffix VALUE |
Only users whose username ends with this. | |
--email VALUE |
Only users with this email. Repeat to match any of several. | |
--email-contains VALUE |
Only users whose email contains this. | |
--email-prefix VALUE |
Only users whose email starts with this. | |
--email-suffix VALUE |
Only users whose email ends with this. | |
--admin |
Only users whose admin is set. Pass --no-admin for the opposite. |
|
--disabled |
Only users whose disabled is set. Pass --no-disabled for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many users. | |
--offset VALUE |
Skip this many users before returning any. | |
--or VALUE |
Only users matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only users matching all of these subfilters, as a JSON or YAML list. |
ceres users count¶
Count users.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only users with this id. Repeat to match any of several. | |
--username VALUE |
Only users with this username. Repeat to match any of several. | |
--username-contains VALUE |
Only users whose username contains this. | |
--username-prefix VALUE |
Only users whose username starts with this. | |
--username-suffix VALUE |
Only users whose username ends with this. | |
--email VALUE |
Only users with this email. Repeat to match any of several. | |
--email-contains VALUE |
Only users whose email contains this. | |
--email-prefix VALUE |
Only users whose email starts with this. | |
--email-suffix VALUE |
Only users whose email ends with this. | |
--admin |
Only users whose admin is set. Pass --no-admin for the opposite. |
|
--disabled |
Only users whose disabled is set. Pass --no-disabled for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many users. | |
--offset VALUE |
Skip this many users before returning any. | |
--or VALUE |
Only users matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only users matching all of these subfilters, as a JSON or YAML list. |
ceres users any¶
Check whether any users match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only users with this id. Repeat to match any of several. | |
--username VALUE |
Only users with this username. Repeat to match any of several. | |
--username-contains VALUE |
Only users whose username contains this. | |
--username-prefix VALUE |
Only users whose username starts with this. | |
--username-suffix VALUE |
Only users whose username ends with this. | |
--email VALUE |
Only users with this email. Repeat to match any of several. | |
--email-contains VALUE |
Only users whose email contains this. | |
--email-prefix VALUE |
Only users whose email starts with this. | |
--email-suffix VALUE |
Only users whose email ends with this. | |
--admin |
Only users whose admin is set. Pass --no-admin for the opposite. |
|
--disabled |
Only users whose disabled is set. Pass --no-disabled for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many users. | |
--offset VALUE |
Skip this many users before returning any. | |
--or VALUE |
Only users matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only users matching all of these subfilters, as a JSON or YAML list. |
ceres users create¶
Create a user.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The user's id. | |
--username VALUE |
yes | The user's username. |
--email VALUE |
yes | The user's email. |
--password VALUE |
The user's password. Prompted for, hidden, when omitted. | |
--admin BOOL |
Mark the user admin. Pass --no-admin for the opposite. |
|
--disabled BOOL |
Mark the user disabled. Pass --no-disabled for the opposite. |
ceres users update¶
Update users, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only users with this id. Repeat to match any of several. | |
--username VALUE |
Only users with this username. Repeat to match any of several. | |
--username-contains VALUE |
Only users whose username contains this. | |
--username-prefix VALUE |
Only users whose username starts with this. | |
--username-suffix VALUE |
Only users whose username ends with this. | |
--email VALUE |
Only users with this email. Repeat to match any of several. | |
--email-contains VALUE |
Only users whose email contains this. | |
--email-prefix VALUE |
Only users whose email starts with this. | |
--email-suffix VALUE |
Only users whose email ends with this. | |
--admin |
Only users whose admin is set. Pass --no-admin for the opposite. |
|
--disabled |
Only users whose disabled is set. Pass --no-disabled for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many users. | |
--offset VALUE |
Skip this many users before returning any. | |
--or VALUE |
Only users matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only users matching all of these subfilters, as a JSON or YAML list. |
ceres users delete¶
Delete users, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only users with this id. Repeat to match any of several. | |
--username VALUE |
Only users with this username. Repeat to match any of several. | |
--username-contains VALUE |
Only users whose username contains this. | |
--username-prefix VALUE |
Only users whose username starts with this. | |
--username-suffix VALUE |
Only users whose username ends with this. | |
--email VALUE |
Only users with this email. Repeat to match any of several. | |
--email-contains VALUE |
Only users whose email contains this. | |
--email-prefix VALUE |
Only users whose email starts with this. | |
--email-suffix VALUE |
Only users whose email ends with this. | |
--admin |
Only users whose admin is set. Pass --no-admin for the opposite. |
|
--disabled |
Only users whose disabled is set. Pass --no-disabled for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many users. | |
--offset VALUE |
Skip this many users before returning any. | |
--or VALUE |
Only users matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only users matching all of these subfilters, as a JSON or YAML list. |
ceres users load¶
Load users from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read users from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres variables¶
Manage variables.
ceres variables select¶
Retrieve variables.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--address VALUE |
Only variables with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--name VALUE |
Only variables with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only variables whose name contains this. | |
--name-prefix VALUE |
Only variables whose name starts with this. | |
--name-suffix VALUE |
Only variables whose name ends with this. | |
--value VALUE |
Only variables with this value. Repeat to match any of several. | |
--internal |
Only variables that are internal. Pass --no-internal for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many variables. | |
--offset VALUE |
Skip this many variables before returning any. | |
--or VALUE |
Only variables matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only variables matching all of these subfilters, as a JSON or YAML list. |
ceres variables count¶
Count variables.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--address VALUE |
Only variables with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--name VALUE |
Only variables with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only variables whose name contains this. | |
--name-prefix VALUE |
Only variables whose name starts with this. | |
--name-suffix VALUE |
Only variables whose name ends with this. | |
--value VALUE |
Only variables with this value. Repeat to match any of several. | |
--internal |
Only variables that are internal. Pass --no-internal for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many variables. | |
--offset VALUE |
Skip this many variables before returning any. | |
--or VALUE |
Only variables matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only variables matching all of these subfilters, as a JSON or YAML list. |
ceres variables any¶
Check whether any variables match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--address VALUE |
Only variables with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--name VALUE |
Only variables with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only variables whose name contains this. | |
--name-prefix VALUE |
Only variables whose name starts with this. | |
--name-suffix VALUE |
Only variables whose name ends with this. | |
--value VALUE |
Only variables with this value. Repeat to match any of several. | |
--internal |
Only variables that are internal. Pass --no-internal for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many variables. | |
--offset VALUE |
Skip this many variables before returning any. | |
--or VALUE |
Only variables matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only variables matching all of these subfilters, as a JSON or YAML list. |
ceres variables create¶
Create a variable.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--address VALUE |
yes | The variable's address. |
--name VALUE |
yes | The variable's name. |
--value VALUE |
yes | The variable's value. |
ceres variables update¶
Update variables, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--address VALUE |
Only variables with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--name VALUE |
Only variables with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only variables whose name contains this. | |
--name-prefix VALUE |
Only variables whose name starts with this. | |
--name-suffix VALUE |
Only variables whose name ends with this. | |
--value VALUE |
Only variables with this value. Repeat to match any of several. | |
--internal |
Only variables that are internal. Pass --no-internal for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many variables. | |
--offset VALUE |
Skip this many variables before returning any. | |
--or VALUE |
Only variables matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only variables matching all of these subfilters, as a JSON or YAML list. |
ceres variables delete¶
Delete variables, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--address VALUE |
Only variables with this address. Repeat to match any of several. | |
--root VALUE |
Resolve relative address selectors against this address. | |
--name VALUE |
Only variables with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only variables whose name contains this. | |
--name-prefix VALUE |
Only variables whose name starts with this. | |
--name-suffix VALUE |
Only variables whose name ends with this. | |
--value VALUE |
Only variables with this value. Repeat to match any of several. | |
--internal |
Only variables that are internal. Pass --no-internal for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many variables. | |
--offset VALUE |
Skip this many variables before returning any. | |
--or VALUE |
Only variables matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only variables matching all of these subfilters, as a JSON or YAML list. |
ceres variables load¶
Load variables from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read variables from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres workspaces¶
Manage workspaces.
ceres workspaces select¶
Retrieve workspaces.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only workspaces with this id. Repeat to match any of several. | |
--name VALUE |
Only workspaces with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only workspaces whose name contains this. | |
--name-prefix VALUE |
Only workspaces whose name starts with this. | |
--name-suffix VALUE |
Only workspaces whose name ends with this. | |
--scope VALUE |
Only workspaces with this scope. Repeat to match any of several. | |
--owner-id VALUE |
Only workspaces with this owner-id. Repeat to match any of several. | |
--show-when-logged-out |
Only workspaces whose show-when-logged-out is set. Pass --no-show-when-logged-out for the opposite. |
|
--placed-on-engine |
Only workspaces that are placed on engine. Pass --no-placed-on-engine for the opposite. |
|
--owned |
Only workspaces that are owned. Pass --no-owned for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspaces. | |
--offset VALUE |
Skip this many workspaces before returning any. | |
--or VALUE |
Only workspaces matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspaces matching all of these subfilters, as a JSON or YAML list. |
ceres workspaces count¶
Count workspaces.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only workspaces with this id. Repeat to match any of several. | |
--name VALUE |
Only workspaces with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only workspaces whose name contains this. | |
--name-prefix VALUE |
Only workspaces whose name starts with this. | |
--name-suffix VALUE |
Only workspaces whose name ends with this. | |
--scope VALUE |
Only workspaces with this scope. Repeat to match any of several. | |
--owner-id VALUE |
Only workspaces with this owner-id. Repeat to match any of several. | |
--show-when-logged-out |
Only workspaces whose show-when-logged-out is set. Pass --no-show-when-logged-out for the opposite. |
|
--placed-on-engine |
Only workspaces that are placed on engine. Pass --no-placed-on-engine for the opposite. |
|
--owned |
Only workspaces that are owned. Pass --no-owned for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspaces. | |
--offset VALUE |
Skip this many workspaces before returning any. | |
--or VALUE |
Only workspaces matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspaces matching all of these subfilters, as a JSON or YAML list. |
ceres workspaces any¶
Check whether any workspaces match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only workspaces with this id. Repeat to match any of several. | |
--name VALUE |
Only workspaces with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only workspaces whose name contains this. | |
--name-prefix VALUE |
Only workspaces whose name starts with this. | |
--name-suffix VALUE |
Only workspaces whose name ends with this. | |
--scope VALUE |
Only workspaces with this scope. Repeat to match any of several. | |
--owner-id VALUE |
Only workspaces with this owner-id. Repeat to match any of several. | |
--show-when-logged-out |
Only workspaces whose show-when-logged-out is set. Pass --no-show-when-logged-out for the opposite. |
|
--placed-on-engine |
Only workspaces that are placed on engine. Pass --no-placed-on-engine for the opposite. |
|
--owned |
Only workspaces that are owned. Pass --no-owned for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspaces. | |
--offset VALUE |
Skip this many workspaces before returning any. | |
--or VALUE |
Only workspaces matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspaces matching all of these subfilters, as a JSON or YAML list. |
ceres workspaces create¶
Create a workspace.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The workspace's id. | |
--name VALUE |
yes | The workspace's name. |
--scope VALUE |
The workspace's scope. | |
--owner-id VALUE |
The workspace's owner-id. | |
--show-when-logged-out BOOL |
Mark the workspace show-when-logged-out. Pass --no-show-when-logged-out for the opposite. |
|
--data VALUE |
The workspace's data. |
ceres workspaces update¶
Update workspaces, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only workspaces with this id. Repeat to match any of several. | |
--name VALUE |
Only workspaces with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only workspaces whose name contains this. | |
--name-prefix VALUE |
Only workspaces whose name starts with this. | |
--name-suffix VALUE |
Only workspaces whose name ends with this. | |
--scope VALUE |
Only workspaces with this scope. Repeat to match any of several. | |
--owner-id VALUE |
Only workspaces with this owner-id. Repeat to match any of several. | |
--show-when-logged-out |
Only workspaces whose show-when-logged-out is set. Pass --no-show-when-logged-out for the opposite. |
|
--placed-on-engine |
Only workspaces that are placed on engine. Pass --no-placed-on-engine for the opposite. |
|
--owned |
Only workspaces that are owned. Pass --no-owned for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspaces. | |
--offset VALUE |
Skip this many workspaces before returning any. | |
--or VALUE |
Only workspaces matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspaces matching all of these subfilters, as a JSON or YAML list. |
ceres workspaces delete¶
Delete workspaces, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only workspaces with this id. Repeat to match any of several. | |
--name VALUE |
Only workspaces with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only workspaces whose name contains this. | |
--name-prefix VALUE |
Only workspaces whose name starts with this. | |
--name-suffix VALUE |
Only workspaces whose name ends with this. | |
--scope VALUE |
Only workspaces with this scope. Repeat to match any of several. | |
--owner-id VALUE |
Only workspaces with this owner-id. Repeat to match any of several. | |
--show-when-logged-out |
Only workspaces whose show-when-logged-out is set. Pass --no-show-when-logged-out for the opposite. |
|
--placed-on-engine |
Only workspaces that are placed on engine. Pass --no-placed-on-engine for the opposite. |
|
--owned |
Only workspaces that are owned. Pass --no-owned for the opposite. |
|
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspaces. | |
--offset VALUE |
Skip this many workspaces before returning any. | |
--or VALUE |
Only workspaces matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspaces matching all of these subfilters, as a JSON or YAML list. |
ceres workspaces load¶
Load workspaces from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read workspaces from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres workspace-edits¶
Manage workspace-edits.
ceres workspace-edits select¶
Retrieve workspace-edits.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only workspace-edits with this user-id. Repeat to match any of several. | |
--workspace-id VALUE |
Only workspace-edits with this workspace-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspace-edits. | |
--offset VALUE |
Skip this many workspace-edits before returning any. | |
--or VALUE |
Only workspace-edits matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspace-edits matching all of these subfilters, as a JSON or YAML list. |
ceres workspace-edits count¶
Count workspace-edits.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only workspace-edits with this user-id. Repeat to match any of several. | |
--workspace-id VALUE |
Only workspace-edits with this workspace-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspace-edits. | |
--offset VALUE |
Skip this many workspace-edits before returning any. | |
--or VALUE |
Only workspace-edits matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspace-edits matching all of these subfilters, as a JSON or YAML list. |
ceres workspace-edits any¶
Check whether any workspace-edits match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only workspace-edits with this user-id. Repeat to match any of several. | |
--workspace-id VALUE |
Only workspace-edits with this workspace-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspace-edits. | |
--offset VALUE |
Skip this many workspace-edits before returning any. | |
--or VALUE |
Only workspace-edits matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspace-edits matching all of these subfilters, as a JSON or YAML list. |
ceres workspace-edits create¶
Create a workspace edit.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
yes | The workspace edit's user-id. |
--workspace-id VALUE |
yes | The workspace edit's workspace-id. |
--data VALUE |
yes | The workspace edit's data. |
ceres workspace-edits update¶
Update workspace-edits, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only workspace-edits with this user-id. Repeat to match any of several. | |
--workspace-id VALUE |
Only workspace-edits with this workspace-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspace-edits. | |
--offset VALUE |
Skip this many workspace-edits before returning any. | |
--or VALUE |
Only workspace-edits matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspace-edits matching all of these subfilters, as a JSON or YAML list. |
ceres workspace-edits delete¶
Delete workspace-edits, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only workspace-edits with this user-id. Repeat to match any of several. | |
--workspace-id VALUE |
Only workspace-edits with this workspace-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many workspace-edits. | |
--offset VALUE |
Skip this many workspace-edits before returning any. | |
--or VALUE |
Only workspace-edits matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only workspace-edits matching all of these subfilters, as a JSON or YAML list. |
ceres workspace-edits load¶
Load workspace-edits from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read workspace-edits from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres groups¶
Manage groups.
ceres groups select¶
Retrieve groups.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only groups with this id. Repeat to match any of several. | |
--name VALUE |
Only groups with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only groups whose name contains this. | |
--name-prefix VALUE |
Only groups whose name starts with this. | |
--name-suffix VALUE |
Only groups whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many groups. | |
--offset VALUE |
Skip this many groups before returning any. | |
--or VALUE |
Only groups matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only groups matching all of these subfilters, as a JSON or YAML list. |
ceres groups count¶
Count groups.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only groups with this id. Repeat to match any of several. | |
--name VALUE |
Only groups with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only groups whose name contains this. | |
--name-prefix VALUE |
Only groups whose name starts with this. | |
--name-suffix VALUE |
Only groups whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many groups. | |
--offset VALUE |
Skip this many groups before returning any. | |
--or VALUE |
Only groups matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only groups matching all of these subfilters, as a JSON or YAML list. |
ceres groups any¶
Check whether any groups match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--id VALUE |
Only groups with this id. Repeat to match any of several. | |
--name VALUE |
Only groups with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only groups whose name contains this. | |
--name-prefix VALUE |
Only groups whose name starts with this. | |
--name-suffix VALUE |
Only groups whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many groups. | |
--offset VALUE |
Skip this many groups before returning any. | |
--or VALUE |
Only groups matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only groups matching all of these subfilters, as a JSON or YAML list. |
ceres groups create¶
Create a group.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
The group's id. | |
--name VALUE |
yes | The group's name. |
--description VALUE |
The group's description. |
ceres groups update¶
Update groups, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only groups with this id. Repeat to match any of several. | |
--name VALUE |
Only groups with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only groups whose name contains this. | |
--name-prefix VALUE |
Only groups whose name starts with this. | |
--name-suffix VALUE |
Only groups whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many groups. | |
--offset VALUE |
Skip this many groups before returning any. | |
--or VALUE |
Only groups matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only groups matching all of these subfilters, as a JSON or YAML list. |
ceres groups delete¶
Delete groups, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--id VALUE |
Only groups with this id. Repeat to match any of several. | |
--name VALUE |
Only groups with this name. Repeat to match any of several. | |
--name-contains VALUE |
Only groups whose name contains this. | |
--name-prefix VALUE |
Only groups whose name starts with this. | |
--name-suffix VALUE |
Only groups whose name ends with this. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many groups. | |
--offset VALUE |
Skip this many groups before returning any. | |
--or VALUE |
Only groups matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only groups matching all of these subfilters, as a JSON or YAML list. |
ceres groups load¶
Load groups from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read groups from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres group-memberships¶
Manage group-memberships.
ceres group-memberships select¶
Retrieve group-memberships.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only group-memberships with this user-id. Repeat to match any of several. | |
--group-id VALUE |
Only group-memberships with this group-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-memberships. | |
--offset VALUE |
Skip this many group-memberships before returning any. | |
--or VALUE |
Only group-memberships matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-memberships matching all of these subfilters, as a JSON or YAML list. |
ceres group-memberships count¶
Count group-memberships.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only group-memberships with this user-id. Repeat to match any of several. | |
--group-id VALUE |
Only group-memberships with this group-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-memberships. | |
--offset VALUE |
Skip this many group-memberships before returning any. | |
--or VALUE |
Only group-memberships matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-memberships matching all of these subfilters, as a JSON or YAML list. |
ceres group-memberships any¶
Check whether any group-memberships match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only group-memberships with this user-id. Repeat to match any of several. | |
--group-id VALUE |
Only group-memberships with this group-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-memberships. | |
--offset VALUE |
Skip this many group-memberships before returning any. | |
--or VALUE |
Only group-memberships matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-memberships matching all of these subfilters, as a JSON or YAML list. |
ceres group-memberships create¶
Create a group membership.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
yes | The group membership's user-id. |
--group-id VALUE |
yes | The group membership's group-id. |
ceres group-memberships update¶
Update group-memberships, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only group-memberships with this user-id. Repeat to match any of several. | |
--group-id VALUE |
Only group-memberships with this group-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-memberships. | |
--offset VALUE |
Skip this many group-memberships before returning any. | |
--or VALUE |
Only group-memberships matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-memberships matching all of these subfilters, as a JSON or YAML list. |
ceres group-memberships delete¶
Delete group-memberships, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only group-memberships with this user-id. Repeat to match any of several. | |
--group-id VALUE |
Only group-memberships with this group-id. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-memberships. | |
--offset VALUE |
Skip this many group-memberships before returning any. | |
--or VALUE |
Only group-memberships matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-memberships matching all of these subfilters, as a JSON or YAML list. |
ceres group-memberships load¶
Load group-memberships from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read group-memberships from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres user-permissions¶
Manage user-permissions.
ceres user-permissions select¶
Retrieve user-permissions.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only user-permissions with this user-id. Repeat to match any of several. | |
--target-type VALUE |
Only user-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only user-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only user-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many user-permissions. | |
--offset VALUE |
Skip this many user-permissions before returning any. | |
--or VALUE |
Only user-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only user-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres user-permissions count¶
Count user-permissions.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only user-permissions with this user-id. Repeat to match any of several. | |
--target-type VALUE |
Only user-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only user-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only user-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many user-permissions. | |
--offset VALUE |
Skip this many user-permissions before returning any. | |
--or VALUE |
Only user-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only user-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres user-permissions any¶
Check whether any user-permissions match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--user-id VALUE |
Only user-permissions with this user-id. Repeat to match any of several. | |
--target-type VALUE |
Only user-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only user-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only user-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many user-permissions. | |
--offset VALUE |
Skip this many user-permissions before returning any. | |
--or VALUE |
Only user-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only user-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres user-permissions create¶
Create a user permission.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
yes | The user permission's user-id. |
--target-type VALUE |
yes | The user permission's target-type. |
--target VALUE |
yes | The user permission's target. |
--level VALUE |
yes | The user permission's level. |
ceres user-permissions update¶
Update user-permissions, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only user-permissions with this user-id. Repeat to match any of several. | |
--target-type VALUE |
Only user-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only user-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only user-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many user-permissions. | |
--offset VALUE |
Skip this many user-permissions before returning any. | |
--or VALUE |
Only user-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only user-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres user-permissions delete¶
Delete user-permissions, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--user-id VALUE |
Only user-permissions with this user-id. Repeat to match any of several. | |
--target-type VALUE |
Only user-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only user-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only user-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many user-permissions. | |
--offset VALUE |
Skip this many user-permissions before returning any. | |
--or VALUE |
Only user-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only user-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres user-permissions load¶
Load user-permissions from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read user-permissions from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |
ceres group-permissions¶
Manage group-permissions.
ceres group-permissions select¶
Retrieve group-permissions.
| Option | Required | Description |
|---|---|---|
<FIELDS> |
Output only these fields, each optionally renamed as field:alias. |
|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--group-id VALUE |
Only group-permissions with this group-id. Repeat to match any of several. | |
--target-type VALUE |
Only group-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only group-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only group-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-permissions. | |
--offset VALUE |
Skip this many group-permissions before returning any. | |
--or VALUE |
Only group-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres group-permissions count¶
Count group-permissions.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--group-id VALUE |
Only group-permissions with this group-id. Repeat to match any of several. | |
--target-type VALUE |
Only group-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only group-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only group-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-permissions. | |
--offset VALUE |
Skip this many group-permissions before returning any. | |
--or VALUE |
Only group-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres group-permissions any¶
Check whether any group-permissions match, reporting through the exit status.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
--group-id VALUE |
Only group-permissions with this group-id. Repeat to match any of several. | |
--target-type VALUE |
Only group-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only group-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only group-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-permissions. | |
--offset VALUE |
Skip this many group-permissions before returning any. | |
--or VALUE |
Only group-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres group-permissions create¶
Create a group permission.
| Option | Required | Description |
|---|---|---|
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--group-id VALUE |
yes | The group permission's group-id. |
--target-type VALUE |
yes | The group permission's target-type. |
--target VALUE |
yes | The group permission's target. |
--level VALUE |
yes | The group permission's level. |
ceres group-permissions update¶
Update group-permissions, reporting how many changed.
| Option | Required | Description |
|---|---|---|
--set OBJECT |
yes | Values to set, as a JSON or YAML object. |
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the updated rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--group-id VALUE |
Only group-permissions with this group-id. Repeat to match any of several. | |
--target-type VALUE |
Only group-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only group-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only group-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-permissions. | |
--offset VALUE |
Skip this many group-permissions before returning any. | |
--or VALUE |
Only group-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres group-permissions delete¶
Delete group-permissions, reporting how many were removed.
| Option | Required | Description |
|---|---|---|
--confirm |
Ask before writing, which is the default when standard input is a terminal. | |
-y, --no-confirm |
Write without asking. | |
--collect |
Output the deleted rows rather than how many. Ordering is not preserved. | |
-o, --output PATH |
Write to this file rather than standard output. | |
-f, --format FORMAT |
Render as JSON lines, CSV, or a table. JSON lines unless --output names a file the shape can be read from. | |
--field FIELD[:ALIAS] |
Output only this field, optionally renamed. Repeatable. | |
--header |
Write a CSV header row, which is the default. --no-header omits it. |
|
--group-id VALUE |
Only group-permissions with this group-id. Repeat to match any of several. | |
--target-type VALUE |
Only group-permissions with this target-type. Repeat to match any of several. | |
--target VALUE |
Only group-permissions with this target. Repeat to match any of several. | |
--level VALUE |
Only group-permissions with this level. Repeat to match any of several. | |
--order VALUE |
Sort by this field, field:desc to reverse. Repeatable. |
|
--limit VALUE |
Return at most this many group-permissions. | |
--offset VALUE |
Skip this many group-permissions before returning any. | |
--or VALUE |
Only group-permissions matching any of these subfilters, as a JSON or YAML list. | |
--and VALUE |
Only group-permissions matching all of these subfilters, as a JSON or YAML list. |
ceres group-permissions load¶
Load group-permissions from a file, reporting how many.
| Option | Required | Description |
|---|---|---|
<PATH> |
yes | The file to read group-permissions from. |
--format FORMAT |
The file's shape. Inferred from its extension when unset. | |
--on-conflict MODE |
What to do about a row whose key already exists. |