import { Steps } from "@astrojs/starlight/components"
import { Tabs, TabItem } from "@astrojs/starlight/components"
import DirectoryLinks from "../../../../components/DirectoryLinks.astro"
import GenAIScriptCli from "../../../../components/GenAIScriptCli.astro"
import { PackageManagers } from "starlight-package-managers"

The GenAIScript CLI **`genaiscript`** runs GenAIScript scripts
outside of Visual Studio and in your [automation](/genaiscript/getting-started/automating-scripts).

<GenAIScriptCli args="..." />

## Prerequisites

The CLI is a Node.JS package hosted on [npm](https://www.npmjs.com/package/genaiscript).

- Install [Node.JS LTS](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (Node.JS includes npm and npx).

:::tip

You need at least Node.JS v22!

:::

## Installation

- Install locally as a `devDependency` in your project.

<PackageManagers pkg="genaiscript" dev frame="none" />

- Install it globally.

```sh "-g"
npm install -g genaiscript
```

- Check that your node version is at least 20._ and npm 10._ by running this command.

```sh
node -v
npx -v
```

```text
v22.16.0
10.9.2
```

## No Installation (`npx`)

> `npx` is installed with **Node.JS**.

Using [npx](https://docs.npmjs.com/cli/v10/commands/npx),
you can run the cli without any prior installation steps.
_npx_ will install the tool on demand. npx also takes care of tricky operating
system issues where the tool is not found in the path.

```sh
npx genaiscript ...
```

- Add `--yes` to skip the confirmation prompt, which is useful in a CI scenario.

```sh "--yes"
npx --yes genaiscript ...
```

- Specify the version range to avoid unexpected behavior with cached installations of the CLI using npx.

```sh "@^1.16.0"
npx --yes genaiscript@^1.16.0 ...
```

## Helper scripts

To make sure that the TypeScript definition files are written and updated,
you can add the following scripts to your `package.json`.

```json title="package.json"
{
    "scripts": {
        "postinstall": "genaiscript scripts fix",
        "postupdate": "genaiscript scripts fix",
        "genaiscript": "genaiscript"
    }
}
```

The `genaiscript` is also a shorthand script that makes it easier to invoke the CLI
using `npm run`:

```sh
npm run genaiscript ...
```

### Working behind a Proxy

Some optional packages used by the CLI do not support an installation behind an HTTP proxy,
which is very common in an enterprise setting.

If your work environment requires going through a proxy,
you should use `npm install --omit=optional`
to have optional packages fail gracefully during the installation.

If your work environment requires going through a proxy,
you can set one of the following environment variables
(`HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` or `https_proxy`) to have the CLI use a proxy,
e.g. `HTTP_PROXY=http://proxy.acme.com:3128`.

## Configuration

The CLI will load the [secrets](/genaiscript/getting-started/configuration) from the environment variables or a `./.env` file.

You can override the default `.env` file name by adding the `--env .env.local` file,
over even import both.

```sh
npx genaiscript run