CLI Reference¶

Reference documentation for the packs CLI.

auth¶

Set up authentication for a Pack

Usage: packs auth <manifestPath>

Options:

--oauthServerPort, --oauth_server_port

Port to use for the local server that handles OAuth setup.

Type: number | Default: 3000

--extraOAuthScopes, --extra_oauth_scopes

Scopes to request beyond those listed in the manifest, for specific formulas that need extra permissions. Example: --extra_oauth_scopes='first second third'

Type: string

build¶

Build your Pack locally (not required; for debugging purposes only)

Usage: packs build <manifestFile>

Options:

--outputDir, -o

Type: string

--minify

Type: boolean | Default: true

--timerStrategy

Options: none, error, fake (default: none).

Type: string

--intermediateOutputDirectory

Type: string

clone¶

Clone an existing Pack that was created using Pack Studio

Usage: packs clone <packIdOrUrl>

Options:

--apiToken, -t

API token to use for the operation. Use the register command to define a default token.

Type: string

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

--yes, -y

Skip confirmation prompts. Required in non-interactive environments.

Type: boolean | Default: false

create¶

Register a new Pack with the server

Usage: packs create <manifestFile>

Options:

--name, -n

The name of the Pack. Can be set later in the UI.

Type: string

--description, -d

A description of the Pack. Can be set later in the UI.

Type: string

--workspace, -w

The workspace ID, or workspace URL that you want your Pack to be created under.

Type: string

--apiToken, -t

API token to use for the operation. Use the register command to define a default token.

Type: string

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

execute¶

Execute a formula

Usage: packs execute <manifestPath> <formulaName> [params..]

Options:

--fetch

Actually fetch http requests instead of using mocks. Run "packs auth" first to set up credentials.

Type: boolean | Default: true

--vm

Execute the requested command in a virtual machine that mimics the environment the platform uses to execute Packs.This defaults to true if the isolated-vm package is installed, and to false if not.

Type: boolean

--dynamicUrl

For a dynamic sync table with a variable source location, specify the URL to test here.

Type: string

--timerStrategy

Options: none, error, fake (default: none).

Type: string

--maxRows

For a sync table, the maximum number of rows to sync.

Type: number | Default: 1000

--allowMultipleNetworkDomains

Allow executing Packs that use multiple network domains. You must get approval from Superhuman before you can upload these Packs.

Type: boolean | Default: false

extensions¶

Installs developer extensions for working with Packs.

Usage: packs extensions <tools..>

init¶

Scaffold a Pack in the current directory

Usage: packs init

Options:

--yes, -y

Skip confirmation prompts. Required in non-interactive environments.

Type: boolean | Default: false

link¶

Link to a pre-existing Pack ID on the server

Usage: packs link <manifestDir> <packIdOrUrl>

Options:

--apiToken, -t

API token to use for the operation. Use the register command to define a default token.

Type: string

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

--yes, -y

Skip confirmation prompts. Required in non-interactive environments.

Type: boolean | Default: false

register¶

Register API token to publish a Pack

Usage: packs register [apiToken]

Options:

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

--open

Open the API token creation page in a browser.

Type: boolean | Default: false

--yes, -y

Skip confirmation prompts. Required in non-interactive environments.

Type: boolean | Default: false

release¶

Set the Pack version that is installable for users. You may specify a specific version, or omit a version to use the version currently in the manifest file. The version must always be higher than that of any previous release.

Usage: packs release <manifestFile> [packVersion]

Options:

--notes, -n

Notes about the contents of this Pack release

Type: string | Required

--gitTag, -g

Create a git tag for this release (default: false). Can also be enabled by default via packs setOption <manifestFile> gitTag true

Type: boolean

--apiToken, -t

API token to use for the operation. Use the register command to define a default token.

Type: string

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

--yes, -y

Skip confirmation prompts. Required in non-interactive environments.

Type: boolean | Default: false

--useLatest

Release the latest uploaded version when the manifest has no version.

Type: boolean | Default: false

setOption¶

Set a persistent build option for the pack (.coda-pack.json)

Usage: packs setOption <manifestFile> <option> <value>

upload¶

Build and upload your Pack version to the server

Usage: packs upload <manifestFile>

Options:

--notes, -n

Notes about the contents of this Pack version

Type: string

--intermediateOutputDirectory, -o

Type: string | Default: ./_upload_build

--timerStrategy

Options: none, error, fake (default: none).

Type: string

--apiToken, -t

API token to use for the operation. Use the register command to define a default token.

Type: string

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string

--allowOlderSdkVersion

Not recommended. Allows uploading a Pack build that uses an older version of the SDK than the prior Pack build.

Type: boolean | Default: false

validate¶

Validate your Pack definition

Usage: packs validate <manifestFile>

Options:

--checkDeprecationWarnings

Also check for warnings about deprecated properties and features that will become errors in a future SDK version.

Type: boolean | Default: true

whoami¶

Looks up information about the API token that is registered in this environment

Usage: packs whoami [apiToken]

Options:

--apiEndpoint, --codaApiEndpoint

API endpoint to use for the operation (default: https://coda.io). Required for single-tenant instances. Can also be set persistently via packs setOption <manifestFile> apiEndpoint <url>.

Type: string