Skip to main content
Version: 2.5

Installation artifacts

An installation artifact is a ZIP carrying configuration changes prepared for a chosen target. Keep source packages in Git; use artifacts as reviewed transport inputs between validation and installation. For first-time CLI setup and credentials, follow the CLI handbook.

Create an artifact​

After populating and validating an existing package directory:

tsm --context prod package artifact create AllConfig --out build/AllConfig-prod.zip

The builder computes a diff against the selected target. There is no separate --diff flag and this command is not a promise to export every unchanged target item. On an empty compatible target, all needed source items can be changes; on an existing target, the planned changes depend on its current state. Inspect the generated plan/content before installation. The target is selected by context/tenant, not the ZIP filename.

Restrict candidates using Git​

tsm --context test package artifact create AllConfig --branch-diff main..HEAD --out build/AllConfig-feature.zip

Without Git selection, artifact contents follow the target diff. With --branch-diff, contents follow the Git changeset plus owned sidecars; the server diff is still computed. This is not an intersection with target changes and does not guarantee applicability to a different target. --area-code and --entity-types provide supported domain filters; see the generated reference. An arbitrary --files input list is not implemented. For a story-specific delivery, prepare/review the intended package contents rather than assuming an unsupported filter.

Publish and install​

tsm package artifact publish build/AllConfig-prod.zip --repository nexus
tsm --context prod package validate --file build/AllConfig-prod.zip
tsm --context prod package diff --file build/AllConfig-prod.zip
tsm --context prod package install --file build/AllConfig-prod.zip

nexus must be a registered accessible artifact repository. Current CLI repository access is anonymous; private repository account login is not implemented and tSM application credentials are not reused there. Validation/diff read server state; install writes it and needs the appropriate target permissions. Review partial results and exit codes. Publishing a ZIP is not deployment, and deleting it does not uninstall configuration.

These are server-backed integration examples requiring a compatible target and repository. The handbook's fresh-config authoring scenarios are independently exercised offline/stub-HTTP; they do not qualify a production install.