> For the complete documentation index, see [llms.txt](https://dev.ubidots.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ubidots.com/sdks/cli/installing.md).

# Installing

Install the Ubidots CLI on your local machine.

### Requirements

* [Python 3.12.2](https://www.python.org/) or higher.

### Installation

```bash
pip install ubidots-cli
```

Once installed, verify the installation by checking the help menu:

```bash
ubidots --help
```

### Optional: Docker for local development

Docker is only needed if you plan to use `ubidots functions dev` or `ubidots pages dev` — the local development environments. For cloud operations (`push`, `pull`, `run`, `logs`, `list`, `get`, `add`, `update`, `delete`), Docker is **not** required.

The `functions dev` environment replicates the production runtime in a Docker container, which is useful when you need to test against the exact library versions before deploying. The `pages dev` environment runs a local preview server with hot reload (currently implemented on top of Docker).

If you do want to install Docker, see the platform-specific guides below.

#### Windows installation troubleshooting

You can use the following resources if you encounter any problems while installing Docker on Windows:

1. [Get started with Docker remote containers on WSL 2](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers)
2. [How to install Linux on Windows with WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
3. [Install Docker Desktop on Windows](https://docs.docker.com/desktop/setup/install/windows-install/)

#### macOS installation troubleshooting

Use the following resource to install Docker on macOS:

1. [Install Docker Desktop on Mac](https://docs.docker.com/desktop/setup/install/mac-install/)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://dev.ubidots.com/sdks/cli/installing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
