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

# Quick Start

# Install

* Supported operating system: macOS, Linux, Windows(Windows Terminal).
* Supported CPU architecture: arm64, amd64

> Windows on Arm (arm64) is not yet supported.

You can install via:

**MacOS / Linux**

```shell theme={null}
curl -fsSL https://qoder.com/install | bash
```

**Windows PowerShell**

```shell theme={null}
irm https://qoder.com/install.ps1 | iex
```

**Windows CMD**

```shell theme={null}
curl -fsSL https://qoder.com/install.cmd -o install.cmd && install.cmd
```

After installation, run the following command. If it prints the CLI version, the installation was successful.

```shell theme={null}
qodercli --version
```

# Sign in

Authentication is required before using Qoder. The CLI will automatically prompt you to sign in the first time you execute a command.

There are two primary methods to authenticate:

* Interactive Sign in (Recommended)
* Environment Variable (for automated scripts)

**Method 1:  Sign in via TUI**

This method allows you to log in directly from the terminal's text-based user interface (TUI).

```shell theme={null}
# Start Qoder CLI in the terminal
qodercli

# In the interactive prompt, enter /login
/login
```

The you can Choose one login method as you need:

* **login with browser**: This will open a Sign in page in your default web browser to complete authentication.
* **login with qoder personal access token**: You will be prompted to paste your Qoder Personal Access Token directly into the terminal.

After you make a selection, the application will guide you through the final steps.

> You can get your personal access token on the page: [https://qoder.com/account/integrations](https://qoder.com/account/integrations)

**Method 2: Sign in via Environment Variable**

For non-interactive sessions or automated environments (e.g., CI/CD pipelines), you can authenticate by setting an environment variable.

```shell theme={null}
# Example for Linux/macOS
export QODER_PERSONAL_ACCESS_TOKEN="your_personal_access_token_here"
```

```shell theme={null}
# Example for Windows (Command Prompt)
set QODER_PERSONAL_ACCESS_TOKEN="your_personal_access_token_here"
```

> If a valid token is set both via the `/login` command and this environment variable, the token provided through `/login` will take precedence.

# Use

Now that you're signed in, you can refer to [Using CLI](https://docs.qoder.com/en/cli/using-cli) and learn how to use the Qoder CLI.

# Upgrade

Automatic upgrade is enabled by default. You can also upgrade manually by the following these methods:

**MacOS / Linux**

```shell theme={null}
curl -fsSL https://qoder.com/install | bash -s -- --force
```

**Windows PowerShell**

```shell theme={null}
irm https://qoder.com/install.ps1 | iex
```

**Windows CMD**

```shell theme={null}
curl -fsSL https://qoder.com/install.cmd -o install.cmd && install.cmd
```

**Use the built-in update feature**

```shell theme={null}
qodercli update
```

To disable automatic upgrade, set `general.enableAutoUpdate` to `false` in `~/.qoder/settings.json`.

```json theme={null}
{
  "general": {
    "enableAutoUpdate": false
  }
}
```

# Sign out

You can sign out using the `/logout` command as you need.

```shell theme={null}
# In the interactive prompt, enter /logout
/logout
```

> If you authenticated using the `QODER_PERSONAL_ACCESS_TOKEN` environment variable, you must unset the variable before running `/logout`.