perpetual parser
Manage parsers.
perpetual parser create
Create a new parser.
perpetual parser create [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Required | Integration ID the parser belongs to (INT_*). |
--name | string | Required | Parser name. |
--query | string | Required | Hamelin query that extracts fields from connector data. |
--connector-ids | string, repeatable | Optional | Connector IDs the parser reads from (comma-separated or repeated). |
--deploy | boolean | Optional | Whether to deploy the parser (default: false). |
--changeset | string | Optional | Changeset (CHG_*) to stage this create into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual parser delete
Delete a parser.
perpetual parser delete <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Parser ID (PRS_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Optional | Integration (INT_*) that owns the parser; skips the org-wide search for it. |
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage into; REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual parser export
Write a parser as a GitOps file.
perpetual parser export <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Parser ID (PRS_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--dir | string | Optional | Directory for a new file (default .). |
--file | string | Optional | Existing .parser.yaml/.json file to edit in place. |
--integration | string | Optional | Integration (INT_*) that owns the parser; skips the org-wide search for it. |
Also accepts the global flags, including the sign-in flags.
perpetual parser get
Get a parser.
perpetual parser get <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Parser ID (PRS_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Optional | Integration (INT_*) that owns the parser; skips the org-wide search for it. |
Also accepts the global flags, including the sign-in flags.
perpetual parser list
List parsers.
perpetual parser list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--space | string, repeatable | Optional | Only these spaces: SPC_* ids, comma-separated or repeated. |
--filter | string | Optional | Raw OData $filter expression, passed to the server as is. |
--integration | string | Optional | Only this integration's parsers (INT_*), read from its endpoint; not with --space. |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual parser update
Update a parser.
perpetual parser update <parserId> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
parserId | Required | Parser ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Required | Integration ID the parser belongs to (INT_*). |
--name | string | Optional | New parser name. |
--query | string | Optional | New Hamelin query. |
--connector-ids | string, repeatable | Optional | New connector IDs (comma-separated or repeated). |
--deploy | boolean | Optional | Whether to deploy the parser. |
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage this update into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0