> For the complete documentation index, see [llms.txt](https://plutuss-organization.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://plutuss-organization.gitbook.io/documentation/quick-start/instalation.md).

# Instalation

Plutus Terminal is an open-source Python package with multiple dependencies. You can install it by downloading the PyApp executable, using pipx, or building it with Poetry.

Github Page: <https://github.com/plutus-terminal/plutus-terminal>

<details>

<summary><strong>Installation using <code>PyApp executable</code></strong></summary>

**To install**

Download the plutus-terminal executable from the [Releases page](https://github.com/plutus-terminal/plutus-terminal/releases) and run it directly.

If the installation fails, run from terminal to and read log errors:

```
<plutus_terminal_executable>
```

**To update**

From the terminal run:

<pre><code><strong>&#x3C;plutus_terminal_executable> self update
</strong></code></pre>

**To uninstall**

```
<plutus_terminal_executable> self remove
```

**Requirements**

&#x20;   **- On Windows:**

* Git
* Microsoft C++ Build Tools

&#x20;   \- **On Linux:**

* Git
* libxcb-cursor-dev

</details>

<details>

<summary><strong>Installation using <code>pipx</code></strong></summary>

**To install**

```
pipx install plutus-terminal
```

Run with:

```
plutus-terminal
```

**To update**

```
pipx upgrade plutus-terminal
```

**To uninstall**

```
pipx uninstall plutus-terminal
```

</details>

<details>

<summary>Build with <strong><code>poetry</code></strong></summary>

**To install**

First, clone the repository:

```
git clone https://github.com/plutus-terminal/plutus-terminal.git
```

Navigate to the cloned repository:

```
cd plutus-terminal
```

Checkout the `main` branch:

```
git checkout main
```

Then, install the package:

```
poetry install
```

Run the tool with:

```
poetry run plutus-terminal
```

**To update**

```
git pull
poetry update
```

</details>
