Skip to main content
Manage local profiles For a detailed overview, please visit the manage CLI profiles guide. 
cpln profile [SUBCOMMAND]

Commands:
  cpln profile delete <profiles...>   Delete one or more referenced profiles
  cpln profile get [profiles...]      Retrieve one or more profiles
  cpln profile login [ref]            Create a profile named "default" and launch a browser to begin the interactive login process
  cpln profile set-default <profile>  Set the referenced profile as the default
  cpln profile token [profile]        Show the JWT token of the referenced profile
  cpln profile update <profile>       Manage the referenced profile  [aliases: create]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]

​
profile delete

Delete one or more referenced profiles Usage 
cpln profile delete <profiles...> [OPTIONS]

Positionals:
  profile  One or more profile names to delete

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
  • Delete one profile
cpln profile delete default
  • Delete multiple profiles
cpln profile delete [email protected] default

​
profile get

Retrieve one or more profiles Usage 
cpln profile get [profiles...] [OPTIONS]
An empty reference will return all references
Positionals:
  profiles  One or more profiles to show  [array] [default: []]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
cpln profile get default

​
profile login

Create a profile named “default” and launch a browser to begin the interactive login process Usage 
cpln profile login [ref] [OPTIONS]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Positionals:
  ref  The resource reference. Usually it is the name of the resource.

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
cpln profile login

​
profile set-default

Set the referenced profile as the default Usage 
cpln profile set-default <profile> [OPTIONS]

Positionals:
  profile  Profile name to be set as the default  [required]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
cpln profile set-default demo-profile

​
profile token

Show the JWT token of the referenced profile Usage 
cpln profile token [profile] [OPTIONS]
An empty reference will return the token for the default profile
Positionals:
  profile  Profile to retrieve the token for

Command options:
  --serve          Serve token on a local server  [boolean]
  --port           Port for the local server  [number] [default: 43200]
  --jwt            View your jwt for the token server  [boolean]
  --generateToken  Generate a new jwt token for the token server  [boolean]

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
cpln profile token demo-profile
Token Server Usage
- 'cpln profile token --serve': Create a server (default port of 43200) instead of outputting the token directly. 
                                This command generates a profile specific token to authenticate against this token server.
- 'cpln profile token --serve --port PORT': Sets the port of the token server.
- 'cpln profile token --jwt': Outputs the token server token for the profile.
- 'cpln profile token --generateToken': Regenerates a token for the profile, for the token server.

An example use case is to integrate the server to a Postman collection. The collection can then make requests to the Control Plane API 
without needing to manually copy the token. After the server is running, by executing the 'cpln profile token --serve' command , the user 
can utilize the Pre-request script below in Postman:

------------------------

const postRequest = {
  url: "http://localhost:" + pm.environment.get("cplnTokenServerPort") + "/" + pm.environment.get("profile") + "/token",
  method: 'GET',
  header: {
    'authorization': "Bearer " + pm.environment.get("cplnTokenServerToken")
  },
};

pm.sendRequest(postRequest, (err, response) => {
    pm.environment.set("token", response.text());
})

------------------------

​
profile update

Manage the referenced profile Usage 
cpln profile update <profile> COMMAND_OPTIONS [OPTIONS]

Positionals:
  profile  Name of the profile to update. If it does not exist, a new profile with that name will be created  [required]

Command options:
  --login    Launch a browser to begin the interactive login process using the referenced profile
  --default  Set the given profile as the default
  --org      Set the given organization as the default organization of the referenced profile
  --gvc      Set the given GVC as the default GVC of the referenced profile

Format options:
  --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
  --color       Colorize the output  [boolean] [default: true]
  --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
  --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

Request options:
  --token         Override the authorization token
  --endpoint      Override the API URL
  --insecure, -k  Ignore TLS errors  [boolean]

Debug options:
  --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
  --debug, -d    Show all HTTP communications  [boolean] [default: false]

Options:
  --version  Show version number  [boolean]
  --help     Show help  [boolean]
Common Options Reference
  • Create a new profile
cpln profile update new-profile
  • Perform an interactive login using a custom profile
cpln profile update new-profile --login
  • Set the referenced profile as the default profile
cpln profile update new-profile --default
  • Set a default organization and GVC on the referenced profile
cpln profile update new-profile --org demo-cpln-organization --gvc demo-gvc
  • Remove default organization and GVC on the referenced profile
cpln profile update new-profile --org "" --gvc ""