MMT Commands#
Informational Commands#
mmt --debug#
Description#
By passing this optional argument on any command all the requests and responses will output in the terminal window.
Usage#
$ mmt -d
$ mmt --debug
mmt --help#
Description#
By running this optional argument a list and information about all the subcommands will be displayed
Usage#
$ mmt -h
$ mmt --help
mmt --version#
Description#
By running this command the MMT version will be display
Usage#
$ mmt -v
$ mmt --version
mmt info#
Description#
Outputs information about a local MMT directory
Usage#
$ mmt info [-h] [path]
Positional Arguments#
path
// The path of the directory
Optional Arguments#
-h, --help
// Show help message and exit
Output#
Remote
Key: KEY_NAME
Store Code: STORE_CODE
Branch Name: BRANCH_NAME
Credential
Key: KEY_NAME
URL: https://domain_name.com/mm5/json.mvc
Method: Token/SSH
Token/UserName: TOKEN_VALUE/SSH_USERNAME
Branch
Name: BRANCH_NAME
Key: BRANCH_KEY
Tags: <None>
Changeset
ID: ID_VALUE
Username: USERNAME
Notes: NOTES
mmt log#
Description#
Lists the changes made to a specific changeset or to a group of changesets
Usage#
$ mmt log [-h] [-c C | -C C] [-v] [path]
Positional Arguments#
path
// The path to the directory
Optional Arguments#
-h, --help
// Show help message and exit
-c C
// Get the changes since a specific changeset
-C C
// Get the changes for a specific changeset
-v, --verbose
// Include a list of modified files within each changeset
mmt status#
Description#
Lists files that have been locally modified
Usage#
$ mmt status [-h] [path]
Positional Arguments#
path
// The path to the directory
Optional Arguments#
-h, --help
// Show help message and exit
Output#
No Files Modified
mmt diff#
Description#
Diff files that have been locally modified
Usage#
$ mmt diff [-h] [filenames [filenames ...]]
Positional Arguments#
filepaths
// The list of local files to diff. If blank, all locally modified files will be diffed
Optional Arguments#
-h, --help
// Show help message and exit
Configurable Commands#
mmt config#
Description#
Configure settings
Usage#
$ mmt config [-h]
mmt config list#
Description#
List value of saved configuration settings
Usage#
$ mmt config list [-h]
Output#
diff: <Not Set>
editor: <Not Set>
mmt config set#
Description#
Set a configuration setting (valid values include ‘diff, editor’).
Usage#
$ mmt config set [-h] key value
Positional Arguments#
key
// Name of the configuration setting (valid values include 'diff, editor')
value
// Value of the configuration setting
VS Code Editor Example
$ mmt config set editor /usr/local/bin/code -- -w
--wait or -w is a command specific to VS Code to tell the editor to wait until the file is closed before continuing. Different editors may have their own flags like this.
mmt config delete#
Description#
Delete configuration setting
Usage#
$ mmt config delete [-h] key
Positional Arguments#
key
// Name of the configuration setting
mmt tag#
Description#
List, add, set, or delete the branch tags
Usage#
$ mmt tag [-h]
Optional Arguments#
-h, --help
// Show help message and exit
mmt tag list#
Description#
List tags
Usage#
$ mmt tag list [-h]
Output#
#TAG_NAME
mmt tag add#
Description#
Add one or more tags
Usage#
$ mmt tag add [-h] tags [tags ...]
Positional Arguments#
tags
// The tags to be added
Optional Arguments#
-h, --help
// Show help message and exit
mmt tag set#
Description#
Overwrite existing tags
Usage#
$ mmt tag set [-h] tags [tags ...]
Positional Arguments#
tags
// The tags to be set
Optional Arguments#
-h, --help
// Show help message and exit
mmt tag delete#
Description#
Delete one or more existing tags
Usage#
$ mmt tag delete [-h] [--all] [tags [tags ...]]
Positional Arguments#
tags
// The tags to be deleted
Optional Arguments#
-h, --help
// Show help message and exit
--all
// Delete all existing tags
mmt tag list#
Description#
List tags
Usage#
$ mmt tag list [-h]
Output#
#TAG_NAME
mmt tag add#
Description#
Add one or more tags
Usage#
$ mmt tag add [-h] tags [tags ...]
Positional Arguments#
tags
// The tags to be added
Optional Arguments#
-h, --help
// Show help message and exit
mmt tag set#
Description#
Overwrite existing tags
Usage#
$ mmt tag set [-h] tags [tags ...]
Positional Arguments#
tags
// The tags to be set
Optional Arguments#
-h, --help
// Show help message and exit
mmt tag delete#
Description#
Delete one or more existing tags
Usage#
$ mmt tag delete [-h] [--all] [tags [tags ...]]
Positional Arguments#
tags
// The tags to be deleted
Optional Arguments#
-h, --help
// Show help message and exit
--all
// Delete all existing tags
mmt credential#
Description#
Store credentials
Usage#
$ mmt credential [-h]
mmt credential list#
Description#
List values of all saved credential keys.
Usage#
$ mmt credential list [-h]
Output Values
Name, Method, URL, Token, Username, Filepath
mmt credential add#
Description#
Add a credential
Usage#
$ mmt credential add [-h] [-h] --url URL [--http-basic-auth-username HTTP_BASIC_AUTH_USERNAME] [--http-basic-auth-password HTTP_BASIC_AUTH_PASSWORD] [--token TOKEN] [--signing-key SIGNING_KEY] [--ssh-username SSH_USERNAME] [--ssh-private-key SSH_PRIVATE_KEY] key
Positional Arguments#
key
// The name of the credential key
Optional Arguments#
-h, --help
// Show help message and exit
--url URL
// The API URL where API will requests will be sent
--http-basic-auth-username HTTP_BASIC_AUTH_USERNAME, -m HTTP_BASIC_AUTH_USERNAME
// HTTP Basic Authentication username
--http-basic-auth-password HTTP_BASIC_AUTH_PASSWORD, -w HTTP_BASIC_AUTH_PASSWORD
// HTTP Basic Authentication password (if the username argument is present and the password
argument is omitted, you will be prompted for the password)
--token TOKEN
// The API token used to make API requests
--signing-key SIGNING_KEY
// The API signing key used to sign API requests
--ssh-username SSH_USERNAME
// The Miva Merchant username associated with the SSH credential
--ssh-private-key SSH_PRIVATE_KEY
// The filepath to the SSH private key
mmt credential update#
Description#
Update a credential
Usage#
$ mmt credential update [-h] [--credential-key CREDENTIAL_KEY] [--url URL] [--http-basic-auth-username HTTP_BASIC_AUTH_USERNAME] [--http-basic-auth-password HTTP_BASIC_AUTH_PASSWORD] [--token TOKEN] [--signing-key SIGNING_KEY] [--ssh-username SSH_USERNAME] [--ssh-private-key SSH_PRIVATE_KEY] key
Positional Arguments#
key
// The key to associate the credential with
Optional Arguments#
-h, --help
// Show help message and exit
--credential-key CREDENTIAL_KEY
// The new credential key value
--url URL
// The API URL where API will requests will be sent
--http-basic-auth-username HTTP_BASIC_AUTH_USERNAME, -m HTTP_BASIC_AUTH_USERNAME
// HTTP Basic Authentication username
--http-basic-auth-password HTTP_BASIC_AUTH_PASSWORD, -w HTTP_BASIC_AUTH_PASSWORD
// HTTP Basic Authentication password (if the username argument is present and the password argument is omitted, you will be prompted for the password)
--token TOKEN
// The API token used to make API requests
--signing-key SIGNING_KEY
// The API signing key used to sign API requests
--ssh-username SSH_USERNAME
// The Miva Merchant username associated with the SSH credential
--ssh-private-key SSH_PRIVATE_KEY
// The filepath to the SSH private key
mmt credential delete#
Description#
Delete a credential
Usage#
$ mmt credential delete [-h] key
Positional Arguments#
key
// Delete credential associated with the key
Optional Arguments#
-h, --help
// Show help message and exit
mmt remote#
Description#
Configure a remote resource
Usage#
mmt remote [-h]
mmt remote list#
Description#
List remote resources
Usage#
$ mmt remote list [-h]
Optional Arguments#
-h, --help
// Show help message and exit
Output Values
REMOTE_KEY
Credential Key: CREDENTIAL_KEY
Store Code: STORE_CODE
Branch Name: BRANCH_NAME
mmt remote add#
Description#
Add a remote resource
Usage#
$ mmt remote add [-h] --credential-key CREDENTIAL_KEY
--branch-name BRANCH_NAME --store-code STORE_CODE key
Positional Arguments#
key
// The key of the remote resource
Optional Arguments#
-h, --help
// Show help message and exit
--credential-key CREDENTIAL_KEY
// The key associated with the stored credential
--branch-name BRANCH_NAME
// The branch name to checkout
--store-code STORE_CODE
// The store code from which to checkout
mmt remote update#
Description#
Update a remote resource
Usage#
$ mmt remote update [-h] [--remote-key REMOTE_KEY] [--credential-key CREDENTIAL_KEY]
[--store-code STORE_CODE] [--branch-name BRANCH_NAME] key
Positional Arguments#
key
// The key of the remote resource
Optional Arguments#
-h, --help
// Show help message and exit
--remote-key REMOTE_KEY
// The new remote key value
--credential-key CREDENTIAL_KEY
// The key associated with the stored credential
--store-code STORE_CODE
// The store code associated with the remote resource
--branch-name BRANCH_NAME
// The branch name associated with the remote resource
mmt remote delete#
Description#
Delete one or more remote resources
Usage#
$ mmt remote remote delete [-h] key [key ...]
Positional Arguments#
key
// Delete remote resources associated with the key
Optional Arguments#
-h, --help
// Show help message and exit
Core Commands#
mmt branch#
Description#
Create, delete or list branches
Usage#
$ mmt branch [-h]
Optional Arguments#
-h, --help
// Show help message and exit
mmt branch list#
Description#
List all branches
Usage#
$ mmt branch list [-h]
--credential-key CREDENTIAL_KEY --store-code STORE_CODE
Optional Arguments#
-h, --help
// Show help message and exit
--credential-key CREDENTIAL_KEY, -c CREDENTIAL_KEY
// The key associated with the remote resource
--store-code STORE_CODE, -s STORE_CODE
// The store code
Value Output
Branch: BRANCH_NAME
Is Primary: True/False
Is Working: True/False
Preview URL: https://DOMAIN_NAME.com/storefront.html?BranchKey=BRANCH_KEY
mmt branch create#
Description#
Create a branch
Usage#
$ mmt branch create [-h] [--color COLOR] --from FROM --store-code STORE_CODE
--credential-key CREDENTIAL_KEY --remote-key REMOTE_KEY name
Positional Arguments#
name
// The branch name
Optional Arguments#
-h, --help
// Show help message and exit
--color COLOR, -c COLOR
// The color used to identify the new branch in the Administrative Interface
--remote-key REMOTE_KEY, -r REMOTE_KEY
// The key associated with the stored remote resource
// Use a Remote Key to automatically derive the credential key, store code, and parent branch name
--from FROM, -f FROM
// The branch name from which to create a new branch from
--store-code STORE_CODE, -s STORE_CODE
// The store code
--credential-key CREDENTIAL_KEY, -c CREDENTIAL_KEY
// The key associated with the stored credential
mmt branch delete#
Description#
Delete a branch
Usage#
$ mmt branch delete [-h] --credential-key CREDENTIAL_KEY --store-code STORE_CODE name
Positional Arguments#
name
// The branch name
Optional Arguments#
-h, --help
// Show help message and exit
--credential-key CREDENTIAL_KEY, -c CREDENTIAL_KEY
// The key associated with the stored credential
--store-code STORE_CODE, -s STORE_CODE
// The store code
mmt checkout#
Description#
Checkout a branch
Usage#
$ mmt checkout [-h] [-c C] [--ignore-unsynced-templates] [--ignore-unsynced-properties] [--reinitialize] remote-key [path]
Positional Arguments#
remote-key
// The key associated with the stored remote resource
path
// The path where the checked out branch should be created
Optional Arguments#
-h, --help
// Show help message and exit
-c C
// Checkout a specific changeset
--ignore-unsynced-templates, -t
// Used to exclude templates
// Email Templates / Email settings
// Product/Category Headers & Footers
// Page Header/Footers
--ignore-unsynced-properties, -p
// Used to exclude all properties
--reinitialize, -z
// Reinitialize the state file to the specified changeset. Files that do not exist are added while files that already exist are left unmodified.
mmt pull#
Description#
Update local files to remote server’s version
Usage#
$ mmt pull [-h] [-c C] [--force] [filepaths [filepaths ...]]
Positional Arguments#
filepaths
// The list of local files to update. If blank, all files within the checked out changeset / the specified changeset will be updated
Optional Arguments#
-h, --help
// Show this help message and exit
-c C
// Update to specified changeset
--force, -f
// Overwrite any locally modified files
mmt push#
Description#
Commit and push the local files to the remote server
Usage#
$ mmt push [-h] [--notes NOTES] [filepaths [filepaths ...]]
Positional Arguments#
filepaths
// The list of local files to commit and push. If blank, all locally modified files will be committed
Optional Arguments#
-h, --help
// Show help message and exit
--notes NOTES, -n NOTES
// Notes describing the changes to be committed
mmt revert#
Description#
Revert files that have been locally modified
Usage#
$ mmt revert [-h] [--all] [filenames [filenames ...]]
Positional Arguments#
filepaths
// The list of local files to revert
Optional Arguments#
-h, --help
// Show help message and exit
--all, -a
// Revert all files
mmt switch#
Description#
Switch to a new remote source
Usage#
$ mmt switch [-h] remote-key
Positional Arguments#
remote-key
// The key associated with the stored remote resource
Optional Arguments#
-h, --help
// Show help message and exit