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

{% file src="/files/DZY43HPxsHN5mvlYhCj5" %}

{% file src="/files/lcEDiLgUgXMQSfm36VBX" %}

{% file src="/files/wW4UwIPvgQE11YJU12n3" %}

{% file src="/files/298h7aNN1emnkG9mlbCa" %}

{% file src="/files/UTgXCMwNHGwk4XbkGZSD" %}

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 [troubleshooting](https://documentation.planeo.dev/troubleshooting) guide for more info.

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

```
$ planeo start

██████╗ ██╗      █████╗ ███╗   ██╗███████╗ ██████╗ 
██╔══██╗██║     ██╔══██╗████╗  ██║██╔════╝██╔═══██╗
██████╔╝██║     ███████║██╔██╗ ██║█████╗  ██║   ██║
██╔═══╝ ██║     ██╔══██║██║╚██╗██║██╔══╝  ██║   ██║
██║     ███████╗██║  ██║██║ ╚████║███████╗╚██████╔╝
╚═╝     ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝ ╚═════╝
🔧 Setting up your API key...

📩 Enter your email: john.doe@acmecorp.com            
👤 Enter your full name: Jon Doe
🏢 Enter your company: Acme Corp

🔄 Assigning API key...
✅ API key successfully configured!

🚀 Starting v0.0.6 server on 127.0.0.1:18168
📖 Read our docs on https://docs.planeo.dev/
👥 Join our communty slack at http://127.0.0.1:18168/slack
🖥️ 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](localhost: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.

**Note:** If you see a permission denied error creating the config.yaml refer to our [troubleshooting](https://documentation.planeo.dev/troubleshooting) guide for more info.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.planeo.dev/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.