> ## Documentation Index
> Fetch the complete documentation index at: https://todocli.vmslab.work/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick install

> How to install and run Todo CLI X

## Quick install (Recommended)

The fastest way to get started with **Todo CLI X** is by installing it globally with [`pipx`](https://pypa.github.io/pipx/), a Python packaging tool for installing CLI applications in isolated environments.

## Requirements

* Python 3.11+
* [pipx](https://pypa.github.io/pipx/)

## Install via `pipx`

First, make sure you have `pipx` installed:

<Tabs>
  <Tab title="macOS (Homebrew)">
    ```bash Bash theme={null}
    brew install pipx
    pipx ensurepath
    pipx install todo-cli-x
    ```
  </Tab>

  <Tab title="Linux / Windows">
    ```bash theme={null}
    python3 -m pip install --user pipx
    python3 -m pipx ensurepath
    pipx install todo-cli-x
    ```
  </Tab>
</Tabs>

<Tip>You may need to restart your terminal or shell after installing pipx.</Tip>

Once installed, you can run the CLI from anywhere:

```bash Bash theme={null}
todo --help
todo add "Submit report" --priority high --due 2025-06-10
todo add "Refactor API" --priority high --due 2025-06-30 --tags dev,urgent
todo list
todo list --verbose
todo list --tags dev
todo edit 2 --text "Refactor user API" --priority medium --tags dev
```

To upgrade later:

```bash Bash theme={null}
pipx upgrade todo-cli-x
```

***

<Warning>`pipx` is recommended if you just want to use the CLI.
The source install is better if you want to contribute or modify the code.</Warning>