Skip to content

Commands

Five commands cover everything the plugin does. Every one of them takes --target-org <alias> (or -o <alias>), except validate, which needs no org.

# Everything in the org
sf Sliick docs export --target-org staging --all --out templates/

# A specific list of templates
sf Sliick docs export --target-org staging --templates Invoice,Quote --out templates/

# A whole bundle (member templates are included by default)
sf Sliick docs export --target-org staging --bundles "Onboarding Pack" --out templates/

# Skip image files for a fast, text-only diff
sf Sliick docs export --target-org staging --all --no-files --out templates/

The export reads templates over the REST surface and downloads any associated image files through the Salesforce REST Files API. That last detail matters: the Files API path means watermarks and image blocks of any size pass through cleanly, with no Apex heap limit to trip over.

# Single artefact
sf Sliick docs import templates/invoice.sdt --target-org prod

# A directory of artefacts, processed in lexical order, one transaction per file
sf Sliick docs import templates/ --target-org prod

# Dry run: see what would change, write nothing
sf Sliick docs import templates/invoice.sdt --target-org prod --dry-run

# CI mode: fail the build on any warning
sf Sliick docs import templates/ --target-org prod --fail-on-warnings

# Import and publish in one step
sf Sliick docs import templates/invoice.sdt --target-org prod --auto-publish

The defaults are tuned for CI:

  • --match-by external-id matches incoming templates to existing rows by their portable identity, so an Invoice exported from staging lands on the same Invoice in prod even if the record Id differs.
  • --on-conflict update updates the existing template’s draft version. Published versions are never silently overwritten.

By default, an import lands templates as a draft and waits for an admin to publish in-org. Pass --auto-publish to publish automatically.

Auto-publish is validation-gated and atomic. If any template in the artefact fails validation in the target org, for example because a merge field references a field that does not exist on the target object, the entire import rolls back. Nothing is imported and nothing is published. That is what makes it safe to wire into a CI pipeline.

Diff: preview the changes before you run them

Section titled “Diff: preview the changes before you run them”
sf Sliick docs diff templates/invoice.sdt --target-org prod

The output marks each template and bundle as CREATE, UPDATE or SKIP against the target org. This is the command you run during a release review, and the one you wire into a pull-request comment if you want reviewers to see the proposed change set before approving the merge.

Validate: check the artefact without an org

Section titled “Validate: check the artefact without an org”
sf Sliick docs validate templates/invoice.sdt

Validate runs offline. It checks the file structure, the schema of the metadata files, and the integrity of any embedded image references. It is fast, and it is the first thing you should run in CI, before you spend an authenticated call on diff or import.

sf Sliick docs template list --target-org prod
sf Sliick docs template list --target-org prod --json

The list shows each template’s External Id, its active (published) version, the latest draft version, and whether a draft is sitting unpublished. The --json flag is the one you want for any scripted use.