search

power-offGetting Started

hashtag
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.

file-archive
24MB
planeo-windows-x86_64-v0.0.7.zip
archive
arrow-up-right-from-squareOpen
file-download
24MB
planeo-linux-x86_64-v0.0.7.tar.gz
arrow-up-right-from-squareOpen
file-download
22MB
planeo-linux-arm64-v0.0.7.tar.gz
arrow-up-right-from-squareOpen
file-download
24MB
planeo-darwin-x86_64-v0.0.7.tar.gz
arrow-up-right-from-squareOpen
file-download
23MB
planeo-darwin-arm64-v0.0.7.tar.gz
arrow-up-right-from-squareOpen

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. Refer to our troubleshootingarrow-up-right guide for more info.

hashtag
First-Run Steps

When running planeo for the first time, you'll need to register to get your API secret which will be written to a config folder within your home directory.

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 18168arrow-up-right, 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.

Note: If you see a permission denied error creating the config.yaml refer to our troubleshootingarrow-up-right guide for more info.

PreviousIntroductionNextRequirements

Last updated