cli

README

Paralus cli

CLI tool to interact with Paralus.

Usage

Download the latest CLI binary and add it to your PATH.

export PATH=$PATH:/usr/local/bin/pctl

Download the config from Paralus dashboard (My Tools -> Download CLI Config), this should be placed in the default directory under $HOME/.paralus/cli. Create the directory if it doesn't exist.

Sample configuration file looks like below:

{
    "profile": "dev",
    "rest_endpoint": "console-ic-oss.dev.paralus-edge.net",
    "ops_endpoint": "console-ic-oss.dev.paralus-edge.net",
    "api_key": "9cfa2b7e009032dd1cd070fff811d59560a5ba28",
    "api_secret": "76f60059a2b6a97535da1394b57fe520c709e4c7f877ce4a4bd665924f6ced11",
    "project": "default",
    "organization": "exampleorg",
    "partner": "example"
}

Features

The CLI allows you an additional way to interact with Paralus. There are commands that you can use to perform certain tasks, for example:

• pctl create p project --desc "Description of the project" to create a project
• pctl create cluster imported sample-imported-cluster to import a cluster
• pctl get users to list all users

For a complete list of commands, refer to our CLI documentation.

Community & Support

• Visit Paralus website for the complete documentation and helpful links.
• Join our Slack channel to post your queries and discuss features.
• Tweet to @paralus_ on Twitter.
• Create GitHub Issues to report bugs or request features.

Contributing

The easiest way to start is to look at existing issues and see if there’s something there that you’d like to work on. You can filter issues with the label “Good first issue” which are relatively self sufficient issues and great for first time contributors.

Once you decide on an issue, please comment on it so that all of us know that you’re on it.

If you’re looking to add a new feature, raise a new issue and start a discussion with the community. Engage with the maintainers of the project and work your way through.