code (Version 0.4.0 and After)

sifflet code workspace

Manages workspaces.

sifflet code workspace init

Description

Creates a new Workspace YAML file locally. The command fails if the file already exists.

sifflet code workspace init --file <file_name> --name <workspace_name>

Options

--file, -f (string, required)

Path of the Workspace YAML file

--name, -n (string, required)

Name of the new workspace

sifflet code workspace list

Description

List all workspaces.

sifflet code workspace list

Options

None.

sifflet code workspace plan

Description

Show the plan for applying the specified workspace (dry-run mode).

sifflet code workspace plan --file <file_name>

Options

--file, -f (string, required)

Path of the Workspace YAML file to deploy

--quiet (flag)

Print only changes with errors and the summary

--fail-on-error (flag)

Fail the entire plan if any error is detected

sifflet code workspace apply

Description

Show the plan for applying the specified workspace (dry-run), then ask for confirmation. Type yes to apply the workspace; any other answer aborts without applying changes.

sifflet code workspace apply --file <file_name>

Options

--file, -f (string, required)

Path of the Workspace YAML file to deploy

--auto-approve (flag)

Skip plan and confirmation, and apply directly

--keep-untracked-resources (flag)

Keep resources that are not tracked by the workspace anymore instead of deleting them

--track-existing-resources (flag)

Track resources that already exist in Sifflet but are not tracked by any workspace, instead of failing the apply (default: fail).

--fail-on-error (flag)

Fail the entire update if any error is detected

--quiet (flag)

Print only changes with errors and the summary

📘

Untracking monitors

By default, if a monitor becomes untracked (i.e., it has been removed from the YAML files), Sifflet deletes it. You can choose to keep it in Sifflet by using the --keep-untracked-resources flag.

⚠️ Note that a monitor is uniquely identified by its ID, so changing the id will cause the monitor with the old ID to be untracked (with all its associated data), and a new monitor to be created.

sifflet code workspace delete

Description

Deletes a workspace and its resources. The command shows the plan for the deletion, then asks for confirmation. Type yes to delete the workspace; any other answer aborts without applying changes.

Identify the workspace either by its file definition or by its ID (use exactly one of --file and --id).

Via the file definition of the workspace:

sifflet code workspace delete --file <file_name>

or via the ID of the workspace:

sifflet code workspace delete --id <id>

Options

--id (UUID)

ID of the workspace to delete

--file, -f (string)

Path of the Workspace YAML file to delete

--keep-resources (flag)

Keep workspace's resources instead of deleting them

--auto-approve (flag)

Skip plan and confirmation, and delete directly

--quiet (flag)

Print only changes with errors and the summary


sifflet code monitor

Manages monitors.

sifflet code monitor init

Description

Creates a new Monitor YAML file locally. The command fails if the file already exists.

sifflet code monitor init --file <file_name> --name <monitor_name>

Options

--file, -f (string, required)

Path of the Monitor YAML file

--name, -n (string, required)

Name of the new monitor


Did this page help you?