• Document Up to Date
  • Updated On 4.0.0

add-remote


Adds a remote repository to a site


Note

The connection to CrafterCMS needs to be setup via the add-environment command before using the command listed here.

Usage

crafter-cli add-remote [--config=path] -e=<environment> -n=<remoteName>
                       [-p=<profile>] -s=<siteId> -u=<remoteUrl>
                       [[--username=<username>] (--password=<password> |
                       --token=<token> | --key=<privateKey>)]

Options

    --config=path         The folder to store configurations
-e, --environment=<environment>
                          The name of the environment
    --key=<privateKey>    The path of the private key for authentication
-n, --name=<remoteName>   The name of the remote repository
-p, --profile=<profile>   The name of the profile (a label to group related configurations)
    --password=<password> The password for authentication
-s, --siteId=<siteId>     The id of the site
    --token=<token>       The token for authentication
-u, --url=<remoteUrl>     The url of the remote repository
    --username=<username> The username for authentication

Example

➜  ./crafter-cli add-remote -e local -s editorial -n origin -u http://github.com/john.doe/editorial.git
Created