diff --git a/docs/cli.html b/docs/cli.html index ef0354646..d48bdd3d5 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -434,8 +434,8 @@
List all active canary deployments
Usage: zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Usage: zapier env:get VERSION
Arguments
version
| The version to get the environment for.Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier env:get 1.2.3
Get the history of your integration.
Usage: zapier history
History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.List integrations you have admin access to.
Usage: zapier integrations
This command also checks the current directory for a linked integration.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
apps
Lists ongoing migration or promotion jobs for the current integration.
Usage: zapier jobs
A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.
Each job will be added to the end of a queue of "promote" and "migration" jobs where the "Job Stage" will then be initialized with "requested".
Job stages will then move to "estimating", "in_progress" and finally one of four "end" stages: "complete", "aborted", "errored" or "paused".
Job times will vary as it depends on the size of the queue and how many users your integration has.
Jobs are returned from oldest to newest.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier jobs
--detailed
| See extra info, like request/response body and headers.-u, --user
| Only show logs for this user. Defaults to your account. Defaults to me
.--limit
| Cap the number of logs returned. Max is 50 (also the default) Defaults to 50
.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.collaborator
, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.subscriber
, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.Use the zapier team:add
and zapier team:remove
commands to modify your team.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
team:list
Get a list of users who have been invited to your integration.
Usage: zapier users:get
Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the zapier users:add
command or the web UI). Users who joined by clicking links generated using the zapier user:links
command won't show up here.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
users:list
Get a list of links that are used to invite users to your integration.
Usage: zapier users:links
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Validate your integration.
Usage: zapier validate
Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during zapier build
, zapier upload
, zapier push
or even as a test in zapier test
.
Flags
--without-style
| Forgo pinging the Zapier server to run further checks.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier validate
zapier validate --without-style
List the versions of your integration available for use in the Zapier editor.
Usage: zapier versions
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.List all active canary deployments
Usage: zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier canary:list
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Usage: zapier env:get VERSION
Arguments
version
| The version to get the environment for.Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier env:get 1.2.3
Get the history of your integration.
Usage: zapier history
History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.List integrations you have admin access to.
Usage: zapier integrations
This command also checks the current directory for a linked integration.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
apps
Lists ongoing migration or promotion jobs for the current integration.
Usage: zapier jobs
A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.
Each job will be added to the end of a queue of "promote" and "migration" jobs where the "Job Stage" will then be initialized with "requested".
Job stages will then move to "estimating", "in_progress" and finally one of four "end" stages: "complete", "aborted", "errored" or "paused".
Job times will vary as it depends on the size of the queue and how many users your integration has.
Jobs are returned from oldest to newest.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier jobs
--detailed
| See extra info, like request/response body and headers.-u, --user
| Only show logs for this user. Defaults to your account. Defaults to me
.--limit
| Cap the number of logs returned. Max is 50 (also the default) Defaults to 50
.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.collaborator
, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.subscriber
, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.Use the zapier team:add
and zapier team:remove
commands to modify your team.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
team:list
Get a list of users who have been invited to your integration.
Usage: zapier users:get
Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the zapier users:add
command or the web UI). Users who joined by clicking links generated using the zapier user:links
command won't show up here.
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Aliases
users:list
Get a list of links that are used to invite users to your integration.
Usage: zapier users:links
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Validate your integration.
Usage: zapier validate
Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during zapier build
, zapier upload
, zapier push
or even as a test in zapier test
.
Flags
--without-style
| Forgo pinging the Zapier server to run further checks.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.Examples
zapier validate
zapier validate --without-style
List the versions of your integration available for use in the Zapier editor.
Usage: zapier versions
Flags
-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.-d, --debug
| Show extra debugging output.-f, --format
| Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]
. Defaults to table
.