Skip to main content

CLI Commands

Run coa --help at any time to see the current command list and global options for your installed version. Run coa <command> --help for flags specific to a subcommand. Use coa describe for built-in documentation that always matches your installed build.

$ coa [options] [command]​

Usage: coa [options] [command]

Options:
  -v, --version                   output the version number
  --verbose                       Show additional detail in command output
  --config <coa-config-location>  coa config file location
  --json                          Output machine-readable JSON instead of human-formatted text
  --no-color                      Disable colored output
  -h, --help                      display help for command

Local Development Commands:
  run       Execute DML (insert/merge) for selected nodes
  create    Execute DDL (create/replace) for selected nodes
  install   Fetch and cache package contents
  validate  Validate YAML schemas and scan workspace for configuration problems
  describe  Explore CLI commands, schemas, and concepts
  doctor    Check config, auth, and warehouse access

Cloud Operations:
  deploy           Apply a deployment plan to an environment
  plan             Diff workspace state against deployed state
  refresh          Run DML for selected nodes in a deployed environment
  rerun            Re-run a failed pipeline from the point of failure
  environments     List and manage deployment environments
  nodes            List and inspect deployed nodes
  jobs             List and inspect deployment jobs
  gitAccounts      Manage Git account connections
  workspace-nodes  List workspace node metadata
  projects         List and manage Coalesce projects
  runs             List and inspect pipeline runs
  cancel           Cancel a running pipeline
Local Development Commands Summary

These commands work against files in your Git checkout and execute SQL in your warehouse using workspaces.yml and ~/.coa/config. They do not replace environment-scoped coa refresh.

  • coa doctor

    Sanity-checks your config, connectivity, and project files. Run this after setting up or changing workspaces.yml or ~/.coa/config.

    coa doctor

  • coa validate

    Runs workspace validation and scanners against your project files. Use this to catch structural issues before running.

    coa validate
    • coa describe

    Displays built-in documentation that matches your installed build. Topics include selectors, SQL annotations, Node types, and more. For SQL-first Node authoring in the product, see Node Type V2.

    coa describe
    coa describe selectors

    Use coa describe as the authoritative reference for your version rather than copying examples from external sources.

    • coa create

    Generates and applies DDL to create or update tables and views in your warehouse for selected Nodes.

    coa create
    coa create --all
    coa create --include <selector> --dry-run

    Supports --dry-run, --include, --exclude, --all, and --list-nodes where applicable. Selector syntax for local commands is documented in coa describe selectors and differs from the OR-keyword style used in coa refresh --include.

    • coa run

    Generates and applies DML to populate tables with data for selected Nodes.

    coa run
    coa run --include <selector>

    Uses the same selector style as coa create. See coa describe selectors for your version's syntax.

    • coa install

    Installs or syncs Marketplace or packaged content when your workflow uses that command.

    coa install

    See coa install --help for options specific to your build.

Cloud Operations Summary

These commands authenticate to Coalesce over HTTPS and require token, domain, and environmentID in your profile:

  • coa plan

    Generates coa-plan.json from the current directory (or --dir) and your profile. Run this from the commit you intend to deploy.

    coa plan
    coa plan --profile databricksOAuthM2M
    coa plan --dir /path/to/repo

    The plan file captures environment, Nodes, Jobs, and related metadata. Review it, but avoid hand-editing; change metadata in the app or files, commit, and regenerate.

    Large projects: Use --enableCache to speed up plan generation. Keep caching off unless plan time is a problem, and review the Caching Deployment Plan documentation before enabling it.

    Common options: --profile, --environmentID, --platformKind, --parameters, --out, --gitsha, and warehouse credential overrides. Run coa plan -h for the full list.

  • coa deploy

    Applies an existing plan file to a Coalesce Environment. Defaults to ./coa-plan.json unless you pass --plan.

    coa deploy
    coa deploy --plan ./coa-plan.json --out deploy-results.json

    Returns run metadata including runType, runStatus, and runResults. Use --out to write JSON results to disk.

  • coa refresh

    Runs a Coalesce-managed refresh (typically DML) for an environment that already has a successful deploy.

    coa refresh
    coa refresh --include '{ location: SAMPLE name: CUSTOMER } OR { location: SAMPLE name: LINEITEM }'
    coa refresh --jobID <id> --parallelism 8 --out refresh-results.json

    Supports --include, --exclude, --jobID, --parallelism, --parameters, --forceIgnoreEnvironmentStatus, and --out.

  • coa rerun

    Retries the failed Nodes from a previous refresh run. Pass the runID of the failed run. Runtime parameters from the original run are not preserved automatically; pass --parameters when you need a new map.

    coa rerun --runID <id>
    coa rerun --runID <id> --parameters '{"key":"value"}'

  • coa cancel

    Cancels an in-flight run by runID.

    coa cancel --runID <id>
API-Style Command Groups

These groups wrap REST-style operations for scripting and automation. Each supports member commands such as list, get, create, put, and delete where applicable.

Command GroupCommon Subcommands
coa environmentslist, get
coa nodeslist, get
coa runslist, get, list-results
coa workspace-nodeslist, create, get, put, delete

Additional groups ship with the product over time. Run coa --help to see your build's full list.

$ coa create [options]​

Execute DDL (create or replace) for selected Nodes in your checked-out project. This runs against the warehouse configured for the workspace in workspaces.yml, not through Coalesce cloud.

Flags

coa create -h

Usage: coa create [options]

Execute DDL (create/replace) for selected nodes

Options:
  -d, --dir <dir>          Coalesce pipeline Yaml file path (default: ".")
  --include <selector>     Node selector syntax (e.g., '{ ORDERS }+', '{ name:
                           "CUSTOMER" }', '{ location: "SRC" }+')
  --exclude <selector>     Node selector syntax for excluding nodes (e.g., '{
                           TEST }', '{ location: "TEMP" }')
  --workspace <workspace>  Workspace name from workspaces.yml (e.g., dev,
                           prod). If not specified, defaults to 'dev'
  --list-nodes             List all available nodes (names and IDs) and exit
  --list-workspaces        List all available workspaces from workspaces.yml
                           and exit
  --dry-run                Preview which nodes would be affected without
                           executing. Use --verbose to see generated SQL
  -h, --help               display help for command

$ coa run [options]​

Execute DML (insert or merge) for selected Nodes. Same workspace and selector model as coa create.

Flags

coa run -h

Usage: coa run [options]

Execute DML (insert/merge) for selected nodes

Options:
  -d, --dir <dir>          Coalesce pipeline Yaml file path (default: ".")
  --include <selector>     Node selector syntax (e.g., '{ ORDERS }+', '{ name:
                           "CUSTOMER" }', '{ location: "SRC" }+')
  --exclude <selector>     Node selector syntax for excluding nodes (e.g., '{
                           TEST }', '{ location: "TEMP" }')
  --workspace <workspace>  Workspace name from workspaces.yml (e.g., dev,
                           prod). If not specified, defaults to 'dev'
  --list-nodes             List all available nodes (names and IDs) and exit
  --list-workspaces        List all available workspaces from workspaces.yml
                           and exit
  --dry-run                Preview which nodes would be affected without
                           executing. Use --verbose to see generated SQL
  -h, --help               display help for command

$ coa validate [options]​

Validate YAML schemas and run workspace scanners (graph and structural checks).

Flags

coa validate -h

Usage: coa validate [options]

Validate YAML schemas and scan workspace for configuration problems

Options:
  -d, --dir <dir>          Root directory to scan for YAML files (default: ".")
  --include <selector>     Node selector to scope graph scanner results (e.g.,
                           '{ STG_ORDERS }', '{ location: "WORK" }'). Schema
                           validation always runs on all files.
  --exclude <selector>     Node selector to exclude from graph scanner results
  --workspace <workspace>  Workspace name from workspaces.yml (default: dev)
                           (default: "dev")
  -h, --help               display help for command

$ coa doctor [options]​

Check configuration, authentication, and warehouse access for a workspace.

Flags

coa doctor -h

Usage: coa doctor [options]

Check config, auth, and warehouse access

Options:
  -d, --dir <dir>          Coalesce pipeline YAML file path (default: ".")
  --workspace <workspace>  Workspace to check (default: dev)
  --fix                    Fix issues where possible (e.g., bootstrap missing
                           workspaces.yml)
  -h, --help               display help for command

$ coa install [options]​

Download and cache package contents for the workspace (uses Coalesce API credentials).

Flags

coa install -h

Usage: coa install [options]

Fetch and cache package contents

Options:
  --token <value>          Coalesce Refresh Token
  --domain <value>         Coalesce domain name to use for API requests
                           (default: "https://app.coalescesoftware.io")
  --profile <value>        Profile To Use
  -d, --dir <dir>          Workspace directory (default: ".")
  --workspace <workspace>  Workspace name from workspaces.yml (e.g., dev,
                           prod). If not specified, defaults to 'dev'
  -h, --help               display help for command

$ coa describe [options] [topic] [subtopic]​

Print long-form help for commands, selectors, schemas, workflows, SQL annotations, and Node types. Topics include commands, command, selectors, schemas, schema, workflow, structure, concepts, sql-format, and node-types. For topic command or schema, pass the command or schema name as subtopic. See Node Type V2 for documentation on SQL-first Node types in Coalesce.

Flags

coa describe -h

Usage: coa describe [options] [topic] [subtopic]

Explore CLI commands, schemas, and concepts

Arguments:
  topic       Topic: commands, command, selectors, schemas, schema, workflow,
              structure, concepts, sql-format, node-types
  subtopic    Subtopic: command name (for 'command') or schema type (for
              'schema')

Options:
  -h, --help  display help for command

$ coa plan [options]​

Compare workspace state in your Git checkout to deployed state and write a deployment plan file (coa-plan.json by default). Run coa plan from the directory that contains your Coalesce project files (or pass --dir).

Caching deployment plan

If you have a large project, --enableCache can speed up your deployments.

Flags

coa plan -h

Usage: coa plan [options]

Diff workspace state against deployed state

Options:
  --token <value>                      Coalesce Refresh Token
  --domain <value>                     Coalesce domain name to use for API
                                       requests (default:
                                       "https://app.coalescesoftware.io")
  --profile <value>                    Profile To Use
  --environmentID <value>              Environment ID
  --include <selector>                 Coalesce Node Selector
  --exclude <selector>                 Coalesce Node Selector
  --jobID <value>                      Coalesce JobID
  --parallelism <value>                Parallelism level to use
  --parameters <value>                 Parameters
  --platformKind <value>               Platform Kind (Snowflake, Databricks)
                                       (default: "Snowflake")
  --snowflakeAuthType <value>          Snowflake Auth Type (Basic, KeyPair)
  --snowflakeAccount <value>           Snowflake Account
  --snowflakeKeyPairKey <value>        Snowflake Key Pair Path
  --snowflakeKeyPairPass <value>       Snowflake Key Pair Pass
  --snowflakePassword <value>          Snowflake Password
  --snowflakeRole <value>              Snowflake Role
  --snowflakeUsername <value>          Snowflake Username
  --snowflakeWarehouse <value>         Snowflake Warehouse
  --snowflakeKeyPairPath <value>       Snowflake Key Pair Path (deprecated,
                                       please use --snowflakeKeyPairKey)
  --databricksAuthType <value>         Databricks Auth Type (OAuthM2M, Token)
  --databricksClientID <value>         Databricks Client ID
  --databricksClientSecret <value>     Databricks Client Secret
  --databricksHost <value>             Databricks Host URL
  --databricksPath <value>             Databricks Path
  --databricksToken <value>            Databricks Token
  --bigQueryAuthType <value>           BigQuery Auth Type (ServiceAccount)
  --bigQueryServiceAccountKey <value>  BigQuery Service Account Key Path
  --bigQueryClientEmail <value>        BigQuery Client Email
  -d, --dir <dir>                      Coalesce pipeline Yaml file path
                                       (default: ".")
  --out <plan-location>                Coalesce plan location (default:
                                       "./coa-plan.json")
  --gitsha <sha>                       Sets the git commit SHA shown in the
                                       plan manifest and UI. This does not
                                       affect which files are used—those come
                                       from the current directory or are set
                                       with the --dir parameter.
  --enableCache                        Enable caching to improve deploy plan
                                       generation times. Coalesce recommends
                                       keeping caching disabled unless you’re
                                       experiencing very long plan generation
                                       times. (default: false)
  -h, --help                           display help for command

$ coa deploy [options]​

Apply an existing coa-plan.json to an environment. You must run coa plan first.

Deploy results

coa returns information about your run, including the following:

  • runType - Returns the type of run. deploy or refresh.
  • runStatus - The status of the run.
    • canceled
    • completed
    • failed
    • running
    • waitingToRun
  • runResults - Includes the SQL executed, any error details, and other environment information.

Flags

coa deploy -h

Usage: coa deploy [options]

Apply a deployment plan to an environment

Options:
  --token <value>                      Coalesce Refresh Token
  --domain <value>                     Coalesce domain name to use for API
                                       requests (default:
                                       "https://app.coalescesoftware.io")
  --profile <value>                    Profile To Use
  --environmentID <value>              Environment ID
  --platformKind <value>               Platform Kind (Snowflake, Databricks)
                                       (default: "Snowflake")
  --snowflakeAuthType <value>          Snowflake Auth Type (Basic, KeyPair)
  --snowflakeAccount <value>           Snowflake Account
  --snowflakeKeyPairKey <value>        Snowflake Key Pair Path
  --snowflakeKeyPairPass <value>       Snowflake Key Pair Pass
  --snowflakePassword <value>          Snowflake Password
  --snowflakeRole <value>              Snowflake Role
  --snowflakeUsername <value>          Snowflake Username
  --snowflakeWarehouse <value>         Snowflake Warehouse
  --snowflakeKeyPairPath <value>       Snowflake Key Pair Path (deprecated,
                                       please use --snowflakeKeyPairKey)
  --databricksAuthType <value>         Databricks Auth Type (OAuthM2M, Token)
  --databricksClientID <value>         Databricks Client ID
  --databricksClientSecret <value>     Databricks Client Secret
  --databricksHost <value>             Databricks Host URL
  --databricksPath <value>             Databricks Path
  --databricksToken <value>            Databricks Token
  --bigQueryAuthType <value>           BigQuery Auth Type (ServiceAccount)
  --bigQueryServiceAccountKey <value>  BigQuery Service Account Key Path
  --bigQueryClientEmail <value>        BigQuery Client Email
  -p, --plan <plan-location>           Coalesce plan location (default:
                                       "./coa-plan.json")
  -o, --out <output json>              Run Results Output in Json
  -h, --help                           display help for command

$ coa refresh [options]​

Run DML for selected Nodes in a deployed Coalesce environment. A successful deploy must exist before refresh.

To re-run a failed refresh, use coa rerun <runID>. That only retries failed Nodes from the prior run.

Refresh results

coa returns information about your run, including the following:

  • runType - Returns the type of run. deploy or refresh.
  • runStatus - The status of the run.
    • canceled
    • completed
    • failed
    • running
    • waitingToRun
  • runResults - Includes the SQL executed, any error details, and other environment information.

Flags

coa refresh -h

Usage: coa refresh [options]

Run DML for selected nodes in a deployed environment

Options:
  --token <value>                      Coalesce Refresh Token
  --domain <value>                     Coalesce domain name to use for API
                                       requests (default:
                                       "https://app.coalescesoftware.io")
  --profile <value>                    Profile To Use
  --environmentID <value>              Environment ID
  --include <selector>                 Coalesce Node Selector
  --exclude <selector>                 Coalesce Node Selector
  --jobID <value>                      Coalesce JobID
  --parallelism <value>                Parallelism level to use
  --parameters <value>                 Parameters
  --platformKind <value>               Platform Kind (Snowflake, Databricks)
                                       (default: "Snowflake")
  --snowflakeAuthType <value>          Snowflake Auth Type (Basic, KeyPair)
  --snowflakeAccount <value>           Snowflake Account
  --snowflakeKeyPairKey <value>        Snowflake Key Pair Path
  --snowflakeKeyPairPass <value>       Snowflake Key Pair Pass
  --snowflakePassword <value>          Snowflake Password
  --snowflakeRole <value>              Snowflake Role
  --snowflakeUsername <value>          Snowflake Username
  --snowflakeWarehouse <value>         Snowflake Warehouse
  --snowflakeKeyPairPath <value>       Snowflake Key Pair Path (deprecated,
                                       please use --snowflakeKeyPairKey)
  --databricksAuthType <value>         Databricks Auth Type (OAuthM2M, Token)
  --databricksClientID <value>         Databricks Client ID
  --databricksClientSecret <value>     Databricks Client Secret
  --databricksHost <value>             Databricks Host URL
  --databricksPath <value>             Databricks Path
  --databricksToken <value>            Databricks Token
  --bigQueryAuthType <value>           BigQuery Auth Type (ServiceAccount)
  --bigQueryServiceAccountKey <value>  BigQuery Service Account Key Path
  --bigQueryClientEmail <value>        BigQuery Client Email
  -o, --out <output json>              Run Results Output in Json
  --forceIgnoreEnvironmentStatus       Ignore the environment status and
                                       refresh even if there is a failed
                                       deploy. This may cause refresh failures!
  -h, --help                           display help for command

$ coa rerun [options] <runID>​

Re-run a failed pipeline from the point of failure. Runtime parameters from the previous run are not preserved.

coa returns the same run fields as coa refresh (run type, status, and results).

Flags

coa rerun -h

Usage: coa rerun [options] <runID>

Re-run a failed pipeline from the point of failure

Arguments:
  runID                                The ID of the failed refresh to re-run

Options:
  --token <value>                      Coalesce Refresh Token
  --domain <value>                     Coalesce domain name to use for API
                                       requests (default:
                                       "https://app.coalescesoftware.io")
  --profile <value>                    Profile To Use
  --environmentID <value>              Environment ID
  --include <selector>                 Coalesce Node Selector
  --exclude <selector>                 Coalesce Node Selector
  --jobID <value>                      Coalesce JobID
  --parallelism <value>                Parallelism level to use
  --parameters <value>                 Parameters
  --platformKind <value>               Platform Kind (Snowflake, Databricks)
                                       (default: "Snowflake")
  --snowflakeAuthType <value>          Snowflake Auth Type (Basic, KeyPair)
  --snowflakeAccount <value>           Snowflake Account
  --snowflakeKeyPairKey <value>        Snowflake Key Pair Path
  --snowflakeKeyPairPass <value>       Snowflake Key Pair Pass
  --snowflakePassword <value>          Snowflake Password
  --snowflakeRole <value>              Snowflake Role
  --snowflakeUsername <value>          Snowflake Username
  --snowflakeWarehouse <value>         Snowflake Warehouse
  --snowflakeKeyPairPath <value>       Snowflake Key Pair Path (deprecated,
                                       please use --snowflakeKeyPairKey)
  --databricksAuthType <value>         Databricks Auth Type (OAuthM2M, Token)
  --databricksClientID <value>         Databricks Client ID
  --databricksClientSecret <value>     Databricks Client Secret
  --databricksHost <value>             Databricks Host URL
  --databricksPath <value>             Databricks Path
  --databricksToken <value>            Databricks Token
  --bigQueryAuthType <value>           BigQuery Auth Type (ServiceAccount)
  --bigQueryServiceAccountKey <value>  BigQuery Service Account Key Path
  --bigQueryClientEmail <value>        BigQuery Client Email
  -o, --out <output json>              Run Results Output in Json
  --forceIgnoreEnvironmentStatus       Ignore the environment status and
                                       refresh even if there is a failed
                                       deploy. This may cause refresh failures!
  -h, --help                           display help for command

$ coa environments [options] [command]​

List and manage deployment environments.

Parent command

coa environments -h

Usage: coa environments [options] [command]

List and manage deployment environments

Options:
  -h, --help      display help for command

Commands:
  list [options]  List Environments
  get [options]   Get Environment
  help [command]  display help for command

coa environments list

coa environments list -h

Usage: coa environments list [options]

List Environments

Options:
  --detail                 Include the full detail of the environments.
                           (default: false)
  --limit <integer>        The maximum number of environments to return.
                           (default: 100)
  --startingFrom <string>  The cursor point for paging the query results.
  --orderBy <string>       The field to order the results by. (default: "id")
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --paging                 Enable interactive paging
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa environments get

coa environments get -h

Usage: coa environments get [options]

Get Environment

Options:
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --environmentID <value>  Environment ID
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

$ coa nodes [options] [command]​

List and inspect deployed Nodes for an environment.

Parent command

coa nodes -h

Usage: coa nodes [options] [command]

List and inspect deployed nodes

Options:
  -h, --help      display help for command

Commands:
  list [options]  List Nodes
  get [options]   Get Node
  help [command]  display help for command

coa nodes list

coa nodes list -h

Usage: coa nodes list [options]

List Nodes

Options:
  --detail                 Include the full detail of the nodes. (default:
                           false)
  --limit <integer>        The maximum number of nodes to return. (default:
                           100)
  --startingFrom <string>  The cursor point for paging the query results.
  --orderBy <string>       The field to order the results by. (default: "id")
  --skipParsing            Skip parsing column references and updating sources
                           for the nodes. (default: false)
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --environmentID <value>  Environment ID
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --paging                 Enable interactive paging
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa nodes get

coa nodes get -h

Usage: coa nodes get [options]

Get Node

Options:
  --nodeID <string>        The node ID.
  --skipParsing            Skip parsing column references and updating sources
                           for the nodes. (default: false)
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --environmentID <value>  Environment ID
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

$ coa jobs [options] [command]​

Inspect deployment jobs.

Parent command

coa jobs -h

Usage: coa jobs [options] [command]

List and inspect deployment jobs

Options:
  -h, --help      display help for command

Commands:
  get [options]   Get Job
  help [command]  display help for command

coa jobs get

coa jobs get -h

Usage: coa jobs get [options]

Get Job

Options:
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --environmentID <value>  Environment ID
  --jobID <value>          Coalesce JobID
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

$ coa gitAccounts [options] [command]​

Manage Git account connections for your organization.

Parent command

coa gitAccounts -h

Usage: coa gitAccounts [options] [command]

Manage Git account connections

Options:
  -h, --help        display help for command

Commands:
  list [options]    List all org git accounts
  create [options]  Create a git account
  get [options]     Get a single git account
  delete [options]  Delete a single git account
  update [options]  Update a single git account
  help [command]    display help for command

coa gitAccounts list

coa gitAccounts list -h

Usage: coa gitAccounts list [options]

List all org git accounts

Options:
  --accountOwner <string>  The owner of the git accounts. If not provided will
                           fallback to the requester's accounts.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa gitAccounts create

coa gitAccounts create -h

Usage: coa gitAccounts create [options]

Create a git account

Options:
  --accountOwner <string>     The owner of the git accounts. If not provided
                              will fallback to the requester's accounts.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

coa gitAccounts get

coa gitAccounts get -h

Usage: coa gitAccounts get [options]

Get a single git account

Options:
  --gitAccountID <string>  The git account ID.
  --accountOwner <string>  The owner of the git accounts. If not provided will
                           fallback to the requester's accounts.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa gitAccounts delete

coa gitAccounts delete -h

Usage: coa gitAccounts delete [options]

Delete a single git account

Options:
  --gitAccountID <string>  The git account ID.
  --accountOwner <string>  The owner of the git accounts. If not provided will
                           fallback to the requester's accounts.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa gitAccounts update

coa gitAccounts update -h

Usage: coa gitAccounts update [options]

Update a single git account

Options:
  --gitAccountID <string>     The git account ID.
  --accountOwner <string>     The owner of the git accounts. If not provided
                              will fallback to the requester's accounts.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

$ coa workspace-nodes [options] [command]​

List and mutate workspace Node metadata through the Coalesce API. For field shapes used by create and update, see Create Node and Set Node.

Parent command

coa workspace-nodes -h

Usage: coa workspace-nodes [options] [command]

List workspace node metadata

Options:
  -h, --help        display help for command

Commands:
  list [options]    List Workspace Nodes
  create [options]  Create Node
  get [options]     Get Node
  put [options]     Set Node
  delete [options]  Delete Node
  help [command]    display help for command

coa workspace-nodes list

coa workspace-nodes list -h

Usage: coa workspace-nodes list [options]

List Workspace Nodes

Options:
  --workspaceID <string>   The workspace ID.
  --detail                 Include the full detail of the nodes. (default:
                           false)
  --limit <integer>        The maximum number of nodes to return. (default:
                           100)
  --startingFrom <string>  The cursor point for paging the query results.
  --orderBy <string>       The field to order the results by. (default: "id")
  --skipParsing            Skip parsing column references and updating sources
                           for the nodes. (default: false)
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --paging                 Enable interactive paging
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa workspace-nodes create

coa workspace-nodes create -h

Usage: coa workspace-nodes create [options]

Create Node

Options:
  --workspaceID <string>      The workspace ID.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

coa workspace-nodes get

coa workspace-nodes get -h

Usage: coa workspace-nodes get [options]

Get Node

Options:
  --workspaceID <string>   The environment ID.
  --nodeID <string>        The node ID.
  --skipParsing            Skip parsing column references and updating sources
                           for the nodes. (default: false)
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa workspace-nodes put

coa workspace-nodes put -h

Usage: coa workspace-nodes put [options]

Set Node

Options:
  --workspaceID <string>      The environment ID.
  --nodeID <string>           The node ID.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

coa workspace-nodes delete

coa workspace-nodes delete -h

Usage: coa workspace-nodes delete [options]

Delete Node

Options:
  --workspaceID <string>  The environment ID.
  --nodeID <string>       The node ID.
  --profile <value>       Profile To Use
  --token <value>         Coalesce Refresh Token
  --skipConfirm           Skip any confirmation prompts
  -h, --help              display help for command

$ coa projects [options] [command]​

List and manage Coalesce projects.

Parent command

coa projects -h

Usage: coa projects [options] [command]

List and manage Coalesce projects

Options:
  -h, --help        display help for command

Commands:
  list [options]    Get Projects
  create [options]  Create Project
  get [options]     Get Project
  delete [options]  Delete Project
  update [options]  Update a project
  help [command]    display help for command

coa projects list

coa projects list -h

Usage: coa projects list [options]

Get Projects

Options:
  --includeWorkspaces      Whether or not to include nested workspace data for
                           all projects.
  --includeJobs            Whether or not to include nested job data for all
                           workspaces in the projects.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa projects create

coa projects create -h

Usage: coa projects create [options]

Create Project

Options:
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

coa projects get

coa projects get -h

Usage: coa projects get [options]

Get Project

Options:
  --projectID <string>     The project ID.
  --includeWorkspaces      Whether or not to include nested workspace data for
                           all projects.
  --includeJobs            Whether or not to include nested job data for all
                           workspaces in the projects.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa projects delete

coa projects delete -h

Usage: coa projects delete [options]

Delete Project

Options:
  --projectID <string>        The project ID.
  --includeWorkspaces         Whether or not to include nested workspace data
                              for all projects.
  --includeJobs               Whether or not to include nested job data for all
                              workspaces in the projects.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

coa projects update

coa projects update -h

Usage: coa projects update [options]

Update a project

Options:
  --projectID <string>        The project ID.
  --includeWorkspaces         Whether or not to include nested workspace data
                              for all projects.
  --includeJobs               Whether or not to include nested job data for all
                              workspaces in the projects.
  --profile <value>           Profile To Use
  --token <value>             Coalesce Refresh Token
  --inputFile <request-file>  The request content
  --outputFile <fileName>     Write output to file
  --format <json|text>        Output results as JSON or text (choices: "json",
                              "text", default: "text")
  --skipConfirm               Skip any confirmation prompts
  -h, --help                  display help for command

$ coa runs [options] [command]​

List and inspect pipeline runs.

Parent command

coa runs -h

Usage: coa runs [options] [command]

List and inspect pipeline runs

Options:
  -h, --help              display help for command

Commands:
  list [options]          List Runs
  get [options]           Get Run
  list-results [options]  List Run Results
  help [command]          display help for command

coa runs list

coa runs list -h

Usage: coa runs list [options]

List Runs

Options:
  --limit <integer>                The maximum number of runs to return.
                                   (default: 25)
  --startingFrom <integer|string>  The starting run ID, runStartTime, or
                                   runEndTime (exclusive) for paging the query
                                   results.
  --orderBy <string>               The field used to sort query results.
                                   Defaults to `id`, but must be explicitly
                                   provided when also using `startingFrom`.
                                   Make sure to match data type.
  --orderByDirection <string>      The sort order for query results. (default:
                                   "desc")
  --projectID <string|array>       One or more project IDs to filter the query
                                   results.
  --runType <string|array>         One or more run types to filter the query
                                   results.
  --runStatus <string|array>       One or more status values to filter the
                                   query results.
  --detail                         Include the full detail of the run.
                                   (default: false)
  --profile <value>                Profile To Use
  --token <value>                  Coalesce Refresh Token
  --environmentID <value>        Environment ID
  --allEnvironments                Include all environments
  --outputFile <fileName>          Write output to file
  --format <json|text>             Output results as JSON or text (choices:
                                   "json", "text", default: "text")
  --paging                         Enable interactive paging
  --skipConfirm                    Skip any confirmation prompts
  -h, --help                       display help for command

coa runs get

coa runs get -h

Usage: coa runs get [options]

Get Run

Options:
  --runID <integer>        The run ID.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

coa runs list-results

coa runs list-results -h

Usage: coa runs list-results [options]

List Run Results

Options:
  --runID <integer>        The run ID.
  --profile <value>        Profile To Use
  --token <value>          Coalesce Refresh Token
  --outputFile <fileName>  Write output to file
  --format <json|text>     Output results as JSON or text (choices: "json",
                           "text", default: "text")
  --skipConfirm            Skip any confirmation prompts
  -h, --help               display help for command

$ coa cancel [options] <runID>​

Cancel a running pipeline.

Flags

coa cancel -h

Usage: coa cancel [options] <runID>

Cancel a running pipeline

Arguments:
  runID                    The ID of the run to cancel.

Options:
  --token <value>          Coalesce Refresh Token
  --domain <value>         Coalesce domain name to use for API requests
                           (default: "https://app.coalescesoftware.io")
  --profile <value>        Profile To Use
  --environmentID <value>  Environment ID
  -h, --help               display help for command

Parallelism Limits​

The --parallelism parameter on coa refresh controls how many Nodes run concurrently against your warehouse. REST refresh APIs cap parallelism at 64; the CLI refresh path is not capped the same way. Choose a value your warehouse can sustain.

Overwriting Defaults​

You can override values from your coa config by passing flags on the command line or by setting the same fields on API requests you send yourself.

Using Include and Exclude​

Cloud commands (coa plan, coa refresh, coa rerun) use the same Selector model as the app. Local coa create, coa run, and coa validate accept selector strings on --include and --exclude. Run coa describe selectors for the exact syntax your build supports.

coa refresh example with include flag
coa refresh --include '{ location: SAMPLE name: CUSTOMER } OR { location: SAMPLE name: LINEITEM } OR { location: SAMPLE name: NATION } OR { location: SAMPLE name: ORDERS } OR { location: SAMPLE name: PART } OR { location: SAMPLE name: PARTSUPP } OR { location: SAMPLE name: REGION } OR { location: SAMPLE name: SUPPLIER } OR { location: QA name: STG_PARTSUPP } OR { location: PROD name: STG_PARTSUPP }'

Selectors​

coa refresh --include and --exclude​

The --include and --exclude flags for coa refresh use the OR keyword (not ||) to separate selector expressions:

coa refresh --include '{ location: SAMPLE name: CUSTOMER } OR { location: SAMPLE name: LINEITEM } OR { location: SAMPLE name: NATION }'

Full selector syntax is documented at the Selector Queries reference page in Coalesce docs.

Local Commands (coa create, coa run)​

Selector syntax for local commands differs from the OR-keyword style used in coa refresh. Open coa describe selectors and follow the examples for your installed version rather than copying snippets across contexts.

What's Next?​