Getting Started
Installation
Install the Planeo CLI by downloading the binary for your architecture from the list below, and extracting it to a location within your system path.
Please reach out if you need a different architecture. You should then be able to run planeo start.
Note for Mac users: After you type planeo start, you will be prompted for verification. When the prompt appears, click "Done." This will add an entry for the application under System Settings > Privacy & Security > App Store and identified developers. Next, click "Allow Anyway" to permit the application to run.
First-Run Steps
When running planeo for the first time, you'll need to provide your API secret which will be written to a config folder within your home directory.
$ planeo start
██████╗ ██╗ █████╗ ███╗ ██╗███████╗ ██████╗
██╔══██╗██║ ██╔══██╗████╗ ██║██╔════╝██╔═══██╗
██████╔╝██║ ███████║██╔██╗ ██║█████╗ ██║ ██║
██╔═══╝ ██║ ██╔══██║██║╚██╗██║██╔══╝ ██║ ██║
██║ ███████╗██║ ██║██║ ╚████║███████╗╚██████╔╝
╚═╝ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═══╝╚══════╝ ╚═════╝
Enter your Planeo API key >
< REDACTED >
Starting server on :18168
Press [Enter] to open the web UI...In the future, the CLI will not prompt for the API key since it is available locally. The Planeo UI should now be available on port 18168, and can be stopped with ctrl+c, which will not terminate provisioned resources.
If you open the UI by pressing Enter, you should see a welcome form prompting you to create a cluster to get started using the tool.
Last updated