Skip to main content

Version: 24.04

T-CLI SCM Commands

scm add​

Add a Maestro project.

Synopsis​

scm project add 'UX Project'

Description​

Create a Maestro project from an existing project. A new project is created on the Maestro server and the local one is renamed.

Examples​

scm project add 'UX Project'

scm clone​

Clone a Maestro project or form version.

Synopsis​

scm project clone ORG/PROJECT [ --org-libs ] [ --release-libs ] [ --tagged-libs ]
scm design clone ORG/PROJECT_NAME_NORM/FORM_DESIGN_TYPE/FORM_DESIGN_NAME_NORM/VERSION [ --tagged-libs ]

Description​

Create a local copy of a Maestro project or a form version.

Cloning a form version will create a single child folder named after the form code, with a single form.json file in it.

FORM_CODE
  • form.json

Cloning a project will create the folder structure:

orgs
  • ORG_CODE
    • PROJECT_CODE
      • forms
        • FORM_CODE
          • FORM_VERSION
            • form.json

Examples​

scm project clone clitest/cliproject
scm design clone clitest/cliproject/forms/cliform/0.1.0

scm connect​

Connect to a server running Maestro.

Synopsis​

scm connect SERVER

Description​

Connects to the server identified by SERVER.

The SERVER parameter is the name or URL of a server running Maestro.

If the connection to SERVER succeeds, you will be prompted to enter a user and password in the terminal window.

Examples​

connect test.maestro.avoka.com
connect https://test.maestro.avoka.com
connect https://test.maestro.avoka.com/maestro/

scm diff​

Show file differences.

Synopsis​

scm design diff
scm project diff

Description​

Shows differences between local files and remote files.

  • scm design diff - Show differences in a single form version file.
  • scm project diff - Show differences for the entire project.

These commands need to be executed from within a local directory which has been cloned from the Maestro server.

  • Execute scm design diff from within CLONE_ROOT/FORM_NAME
  • Execute scm project diff from within CLONE_ROOT/orgs/ORG_NAME/PROJECT_NAME

CLONE_ROOT in the paths above represents the local directory in which the original scm clone command was issued.

Examples​

cd orgs/clitestorg/cli-test-project
scm project diff

scm pull​

Update local files from a Maestro server.

Synopsis​

scm design pull
scm project pull

Description​

Updates local files that have changed on the server.

  • scm design pull - Update a single form version file.
  • scm project pull - Update all changed files for the entire project.

These commands need to be executed from within a local directory which has been cloned from the Maestro server.

  • Execute scm design pull from within CLONE_ROOT/FORM_NAME.
  • Execute scm project pull from within CLONE_ROOT/orgs/ORG_NAME/PROJECT_NAME.

CLONE_ROOT in the paths above represents the local directory in which the original scm clone command was issued.

Examples​

cd orgs/clitestorg/cli-test-project
scm project pull

scm push​

Commit local changes to a server.

Synopsis​

scm design push
scm project push

Description​

Commit local files that have been modified to the server.

  • scm design push - Commit a single form version file.
  • scm project push - Commit all changed files for the entire project.

These commands need to be executed from within a local directory which has been cloned from the Maestro server.

  • Execute scm design push from within CLONE_ROOT/FORM_NAME.
  • Execute scm project push from within CLONE_ROOT/orgs/ORG_NAME/PROJECT_NAME.

CLONE_ROOT in the paths above represents the local directory in which the original scm clone command was issued.

Examples​

cd orgs/clitestorg/cli-test-project
scm project push

scm status​

Display SCM status information.

Synopsis​

scm design status
scm project status

Description​

Lists the names of files that have either changed locally, or have changed on the Maestro server.

These commands need to be executed from within a local directory which has been cloned from the Maestro server.

  • Execute scm design status from within CLONE_ROOT/FORM_NAME.
  • Execute scm project status from within CLONE_ROOT/orgs/ORG_NAME/PROJECT_NAME.

CLONE_ROOT in the paths above represents the local directory from which the original scm clone command was issued.

Examples​

cd orgs/clitestorg/cli-test-project
scm project status