> For the complete documentation index, see [llms.txt](https://picsellia.gitbook.io/picsellia/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://picsellia.gitbook.io/picsellia/hyperparameter-tuning/install-picsell-cli.md).

# Install Picsell CLI

The CLI Picsellia is the simplest way to manage and orchestrate your training in order to find your best hyper-parameters

### 1 . Prerequisites

You need to have Docker installed to use the CLI as it will launch your Scan in Docker Container

**Install Docker on Windows :** [**https://docs.docker.com/docker-for-windows/install/**](https://docs.docker.com/docker-for-windows/install/)

**Install Docker on macOS :** [**https://docs.docker.com/docker-for-mac/install/**](https://docs.docker.com/docker-for-mac/install/) 

**Install Docker on Linux :** [**https://docs.docker.com/engine/install/ubuntu/**](https://docs.docker.com/engine/install/ubuntu/)

### 2 . Installation 

{% tabs %}
{% tab title="macOS" %}
To install the Picsell CLI on Linux:

1. Download the latest `darwin` tar.gz file from <https://github.com/PicselliaTeam/PicsellAgent/releases>
2. Unzip the file: `tar -xvf picsell_X.X.X_darwin_x86_64.tar.gz`

Optionally, install the binary in a location where you can execute it globally (e.g., `/usr/local/bin`) or create a symbolic link with

`sudo ln -s $(PWD)/picsell /usr/local/bin`
{% endtab %}

{% tab title="Linux" %}
To install the Picsell CLI on Windows:

1. Download the latest `linux` zip file from <https://github.com/PicselliaTeam/PicsellAgent/releases>
2. `tar -xvf picsell_X.X.X_linux_386.tar.gz`

Optionally, install the binary in a location where you can execute it globally (e.g., `/usr/local/bin`) or create a symbolic link with

`sudo ln -s $(PWD)/picsell /usr/local/bin`
{% endtab %}

{% tab title="Windows" %}
To install the Picsell CLI on macOS:

1. Download the latest `windows` tar.gz file from <https://github.com/PicselliaTeam/PicsellAgent/releases>
2. Unzip the file: `picsell_X.X.X_windows_386.tar.gz`
3. Run the unzipped `.exe` file
   {% endtab %}
   {% endtabs %}

### 3 . Add your PICSELLIA TOKEN to your env variables&#x20;

{% tabs %}
{% tab title="macOS" %}
Just add you picsellia token to your bash\_profile&#x20;

`vim ~/.bash_profile`

`export PICSELLIA_TOKEN=yourtoken`

`source ~/.bash_profile`
{% endtab %}

{% tab title="Linux" %}
Add PICSELLIA\_TOKEN to your bashrc file and source it&#x20;

`nano ~/.bashrc`

`export PICSELLIA_TOKEN=your_token`

`source ~/.bashrc`
{% endtab %}

{% tab title="Windows" %}
Then just put your picsellia token available in your profile  &#x20;

1 . Right click on Computer, Advanced system settings

2 . Select Advanced tab and click Environment variables.

3\. Add an env variable `PICSELLIA_TOKEN`&#x20;
{% endtab %}
{% endtabs %}

### 4 . Run the CLI&#x20;

{% tabs %}
{% tab title="macOS" %}
`picsell -h` if you put picsell CLI in your path or&#x20;

`./picsell -h`&#x20;

![](https://2100239547-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M78aoA9Gcxf25O1fNjm%2F-MZsBfNmq8wbGfzxJ4C9%2F-MZsBrth2PEjGGxlc2FV%2Fimage.png?alt=media\&token=6289d78e-fd79-420e-92ef-f2ab3588988f)
{% endtab %}

{% tab title="Linux" %}
`picsell -h` if you put picsell CLI in your path or&#x20;

`./picsell -h`&#x20;

![](https://2100239547-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M78aoA9Gcxf25O1fNjm%2F-MZsBfNmq8wbGfzxJ4C9%2F-MZsBpF840kU4aaonsUX%2Fimage.png?alt=media\&token=9a7a8b36-0f3d-448a-b2fd-4a9ad86406b7)
{% endtab %}

{% tab title="Windows" %}
`picsell -h`

![](https://2100239547-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M78aoA9Gcxf25O1fNjm%2F-MZsBfNmq8wbGfzxJ4C9%2F-MZsBvn-N_Un_stnfTNO%2Fimage.png?alt=media\&token=95e41de8-d375-416a-81e5-8a0596cbbe7c)
{% endtab %}
{% endtabs %}