Goals

Goal commands enable you to manage goals in your Knock account from the CLI.

When goals are pulled from Knock, they are stored in directories named by their goal key. Each goal directory contains a goal.json file that describes the goal's configuration (name, description, and condition).

goals/
└── trial-conversion/
  └── goal.json

If you're migrating your local goal files into Knock, you can arrange them using the example file structure above and then push them into Knock with a single command using knock goal push --all.

To attach a goal to a workflow, broadcast, or guide, set goal_attachment on that resource's JSON (goal_key and attribution_window_days). Attachments are not stored on the goal itself.

Display all goals for an environment. Use an --environment flag to specify the target environment; if omitted, the Knock CLI defaults to the development environment.

Flags

Display a single goal from an environment.

Use an --environment flag to specify the target environment; if omitted, the Knock CLI defaults to the development environment.

Flags

Pull one or more goals from an environment into a local file system. Knock CLI will create a new goal directory or update the existing goal directory in the local file system.

By default this command will resolve to the goals resource directory via your knock.json file. When not set, will use the current working directory as the default. In the case of the --all flag, the target directory path will be resolved via your knock.json file or the --goals-dir flag.

Note: if pulling the target goal for the first time (or all goals), Knock CLI will ask to confirm before writing to the local file system.

See the Goal file structure section for details on how goal files are organized.

Flags

Push one or more goals from a local file system to Knock. Knock will update an existing goal by the matching goal key, or create a new goal if it does not exist yet. Goal upserts publish immediately; this command does not accept a --commit flag.

By default this command will resolve to the goals resource directory via your knock.json file. When not set, will use the current working directory as the default. In the case of the --all flag, the target directory path will be resolved via your knock.json file or the --goals-dir flag.

Note:

• You must be directly above the target goal directory when running the goal push command, so the CLI can locate the goal.json file.
• Use --force to bypass environment restrictions and overwrite content in any environment.

See the Goal file structure section for details on how goal files are organized.

Flags

Validate one or more goals from a local file system. Knock will validate the given goal payload in the same way as it would with the goal push command, except without persisting those changes.

Flags

Create a new goal with a minimal configuration. The command creates a new goal directory in your local file system. By default, this will be in the goals resource directory set by your knock.json file, or the current working directory if not configured.

Flags

Open a goal in the Knock dashboard. This command opens the goal page in your default browser.

Flags

Archive a goal. Archiving stops new completion and attribution calculation for the goal and cannot be undone. Historical versions and completions are retained.

Flags

Clone a goal into a destination environment. Cloning copies the latest version of the goal (name, description, and condition). It does not copy attachments to workflows, broadcasts, or guides.

Flags