Volta

https://docs.volta.sh/
Admin
Volta is a fast and reliable JavaScript tool manager designed to help developers manage their...
Tokens:7,216
Snippets:107
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Volta setup command syntax

Source: https://docs.volta.sh/reference/setup

Displays the usage and available flags for the volta setup command.

```text
Enables Volta for the current user

USAGE:
    volta setup [FLAGS]

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information
```

--------------------------------

### Install Volta on Windows

Source: https://docs.volta.sh/guide/getting-started

The recommended installation method for Windows users via winget.

```powershell
winget install Volta.Volta
```

--------------------------------

### Volta install command syntax

Source: https://docs.volta.sh/reference/install

Displays the usage, flags, and arguments for the volta install command.

```text
Installs a tool in your toolchain

USAGE:
    volta install [FLAGS] <tool[@version]>...

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information

ARGS:
    <tool[@version]>...    Tools to install, like `node`, `yarn@latest` or `your-package@^14.4.3`.
```

--------------------------------

### Skip Volta Setup during installation

Source: https://docs.volta.sh/advanced/installers

Use the --skip-setup flag to prevent the installer from modifying profile scripts on Unix systems.

```bash
curl https://get.volta.sh | bash -s -- --skip-setup
```

--------------------------------

### Install local builds

Source: https://docs.volta.sh/contributing/index

Use the provided helper scripts to install development or release versions of Volta.

```bash
./dev/unix/volta-install.sh --dev
```

```bash
./dev/unix/volta-install.sh --release
```

--------------------------------

### Install Volta on Unix

Source: https://docs.volta.sh/guide/getting-started

Use this command to install Volta on macOS and most Unix-based systems.

```bash
curl https://get.volta.sh | bash
```

--------------------------------

### Install a Node.js version

Source: https://docs.volta.sh/guide

Fetches and sets the active version of Node.js for the current environment.

```bash
volta install node@22
```

--------------------------------

### Install and run global package binaries

Source: https://docs.volta.sh/guide

Installs a package globally and executes its binary, ensuring it remains pinned to the current Node engine.

```bash
npm install -g surge
surge -h
```

--------------------------------

### Example hooks.json configuration

Source: https://docs.volta.sh/advanced/hooks

Defines custom index, latest, and distro URLs for Node, npm, and Yarn using bin, prefix, and template hooks.

```json
{
    "node": {
        "index": {
            "bin": "/usr/local/node-lookup"
        },
        "latest": {
            "prefix": "http://example.com/node/"
        },
        "distro": {
            "template": "http://example.com/{{os}}/{{arch}}/node-{{version}}.tar.gz"
        }
    },
    "npm": {
        "index": {
            "prefix": "http://example.com/npm/"
        },
        "latest": {
            "bin": "~/npm-latest"
        },
        "distro": {
            "template": "http://example.com/npm/npm-{{version}}.tgz"
        }
    },
    "yarn": {
        "index": {
            "template": "http://example.com/yarn/{{os}}/{{arch}}/yarn-{{version}}.tgz"
        },
        "latest": {
            "prefix": "http://example.com/yarnpkg/"
        },
        "distro": {
            "bin": "~/yarn-distro"
        }
    }
}
```

--------------------------------

### Configure Rust formatting

Source: https://docs.volta.sh/contributing/index

Install and run rustfmt to ensure code style consistency.

```bash
rustup component add rustfmt
```

```bash
cargo fmt --all
```

--------------------------------

### Install global package binaries

Source: https://docs.volta.sh/guide/understanding

Installs a package globally, adding its executables to the Volta toolchain pinned to the current default Node version.

```bash
yarn global add vuepress
```

--------------------------------

### Install specific older versions of Volta

Source: https://docs.volta.sh/advanced/installers

Use the custom installation script to install versions older than 1.1.0 on Unix systems by specifying the version number.

```bash
curl https://raw.githubusercontent.com/volta-cli/volta/8f2074f423c65405dfba9858d9bcf393c38ffb45/dev/unix/volta-install.sh | bash -s -- --version 1.0.8
```

--------------------------------

### Install default Node.js versions

Source: https://docs.volta.sh/guide/understanding

Sets the default Node.js version for the toolchain, which is used unless overridden by a project-specific configuration.

```bash
volta install node@22.5.1
```

```bash
volta install node@22
```

```bash
volta install node
```

--------------------------------

### Install package with specific Node version

Source: https://docs.volta.sh/advanced/packages

Overrides the default pinning behavior by specifying a target Node version during installation.

```bash
volta run --node 15 npm i -g ember-cli
```

--------------------------------

### volta list

Source: https://docs.volta.sh/reference/list

Inspects installed Node runtimes, package managers, and packages with binaries.

```APIDOC
## volta list

### Description
Inspects your installed Node runtimes, package managers, and packages with binaries.

### Usage
`volta list [FLAGS] [OPTIONS] [tool]`

### Flags
- **-c, --current** - Show the currently-active tool(s).
- **-d, --default** - Show your default tool(s).
- **--verbose** - Enables verbose diagnostics.
- **--quiet** - Prevents unnecessary output.
- **-h, --help** - Prints help information.

### Options
- **--format <format>** - Specify the output format. Possible values: human, plain. Defaults to human for TTYs, plain otherwise.

### Arguments
- **tool** - The tool to lookup: `all`, `node`, `yarn`, or the name of a package or binary.
```

--------------------------------

### Volta CLI Usage and Help

Source: https://docs.volta.sh/reference/index

Displays the standard usage syntax, available flags, and subcommands for the volta binary.

```text
The JavaScript Launcher ⚡

    To install a tool in your toolchain, use `volta install`.
    To pin your project's runtime or package manager, use `volta pin`.

USAGE:
    volta [FLAGS] [SUBCOMMAND]

FLAGS:
        --verbose    
            Enables verbose diagnostics

        --quiet      
            Prevents unnecessary output

    -v, --version    
            Prints the current version of Volta

    -h, --help       
            Prints help information


SUBCOMMANDS:
    fetch          Fetches a tool to the local machine
    install        Installs a tool in your toolchain
    uninstall      Uninstalls a tool from your toolchain
    pin            Pins your project's runtime or package manager
    list           Displays the current toolchain
    completions    Generates Volta completions
    which          Locates the actual binary that will be called by Volta
    setup          Enables Volta for the current user / shell
    help           Prints this message or the help of the given subcommand(s)
```

--------------------------------

### Compile Volta from source

Source: https://docs.volta.sh/contributing/index

Use Cargo to compile the project from the source code.

```bash
cargo build
```

--------------------------------

### Display Volta help syntax

Source: https://docs.volta.sh/reference/help

Shows the usage pattern and argument structure for the help command.

```text
Prints this message or the help of the given subcommand(s)

USAGE:
    volta help [subcommand]...

ARGS:
    <subcommand>...    The subcommand whose help message to display
```

--------------------------------

### Run project tests

Source: https://docs.volta.sh/contributing/index

Execute the test suite with the mock-network feature enabled.

```bash
cargo test --all --features mock-network
```

--------------------------------

### Volta fetch command syntax and usage

Source: https://docs.volta.sh/reference/fetch

Displays the command-line interface syntax, flags, and arguments for the volta fetch command.

```text
Fetches a tool to the local machine

USAGE:
    volta fetch [FLAGS] <tool[@version]>...

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information

ARGS:
    <tool[@version]>...    Tools to fetch, like `node`, `yarn@latest` or `your-package@^14.4.3`.
```

--------------------------------

### Manage project-specific tool versions

Source: https://docs.volta.sh/guide/understanding

Demonstrates how global tools like TypeScript automatically switch versions based on the current project directory.

```bash
npm install --global typescript
```

```bash
cd /path/to/project-using-typescript-4.9.5
tsc --version # 4.9.5

cd /path/to/project-using-typescript-5.5.4
tsc --version # 5.5.4
```

--------------------------------

### Volta run command syntax

Source: https://docs.volta.sh/reference/run

Displays the usage, flags, options, and arguments available for the volta run command.

```text
Run a command with custom Node, npm, and/or Yarn versions

USAGE:
    volta run [FLAGS] [OPTIONS] <command> [--] [args]...

FLAGS:
        --bundled-npm    Forces npm to be the version bundled with Node
        --no-yarn        Disables Yarn
        --verbose        Enables verbose diagnostics
        --quiet          Prevents unnecessary output
    -h, --help           Prints help information

OPTIONS:
        --node <version>         Set the custom Node version
        --npm <version>          Set the custom npm version
        --yarn <version>         Set the custom Yarn version
        --env <NAME=value>...    Set an environment variable (can be used multiple times)

ARGS:
    <command>    The command to run
    <args>...    Arguments to pass to the command
```

--------------------------------

### Volta Completions Command Syntax

Source: https://docs.volta.sh/reference/completions

Displays the command-line interface usage, flags, and arguments for generating shell completions.

```text
Generates Volta completions

By default, completions will be generated for the value of your current shell,
shell, i.e. the value of `SHELL`. If you set the `<shell>` option, completions
will be generated for that shell instead.

If you specify a directory, the completions will be written to a file there;
otherwise, they will be written to `stdout`.


USAGE:
    volta completions [FLAGS] [OPTIONS] <shell>

FLAGS:
    -f, --force
            Write over an existing file, if any.

        --verbose
            Enables verbose diagnostics

        --quiet
            Prevents unnecessary output

    -h, --help
            Prints help information


OPTIONS:
    -o, --output <out_file>
            File to write generated completions to


ARGS:
    <shell>
            Shell to generate completions for [possible values: zsh, bash, fish, powershell,
            elvish]
```

--------------------------------

### volta which command syntax

Source: https://docs.volta.sh/reference/which

Displays the usage, flags, and arguments for the volta which command.

```text
Locates the actual binary that will be called by Volta

USAGE:
    volta which [FLAGS] <binary>

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information

ARGS:
    <binary>    The binary to find, e.g. `node` or `npm`
```

--------------------------------

### Volta uninstall command syntax

Source: https://docs.volta.sh/reference/uninstall

Displays the command-line interface usage, flags, and arguments for the uninstall command.

```text
Uninstalls a tool from your toolchain

USAGE:
    volta uninstall [FLAGS] <tool>

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information

ARGS:
    <tool>    The tool to uninstall, e.g. `node`, `npm`, `yarn`, or <package>
```

--------------------------------

### volta run

Source: https://docs.volta.sh/reference/run

Executes a command with specified tool versions and environment variables.

```APIDOC
## volta run

### Description
Runs a command using specific versions of tools. Version settings must be provided before the command, while arguments for the command follow it.

### Usage
`volta run [FLAGS] [OPTIONS] <command> [--] [args]...`

### Flags
- **--bundled-npm** - Forces npm to be the version bundled with Node
- **--no-yarn** - Disables Yarn
- **--verbose** - Enables verbose diagnostics
- **--quiet** - Prevents unnecessary output
- **-h, --help** - Prints help information

### Options
- **--node <version>** - Set the custom Node version
- **--npm <version>** - Set the custom npm version
- **--yarn <version>** - Set the custom Yarn version
- **--env <NAME=value>** - Set an environment variable (can be used multiple times)

### Arguments
- **<command>** - The command to run
- **[args]...** - Arguments to pass to the command
```

--------------------------------

### Volta list command syntax

Source: https://docs.volta.sh/reference/list

Displays the usage syntax, flags, and options available for the volta list command.

```text
Displays the current toolchain

USAGE:
    volta list [FLAGS] [OPTIONS] [tool]

FLAGS:
    -c, --current    
            Show the currently-active tool(s).
            
            Equivalent to `volta list` when not specifying a specific tool.
    -d, --default    
            Show your default tool(s).

        --verbose    
            Enables verbose diagnostics

        --quiet      
            Prevents unnecessary output

    -h, --help       
            Prints help information


OPTIONS:
        --format <format>    
            Specify the output format.
            
            Defaults to `human` for TTYs, `plain` otherwise. [possible values: human, plain]

ARGS:
    <tool>    
            The tool to lookup: `all`, `node`, `yarn`, or the name of a package or binary.
```

--------------------------------

### Pin a Node.js version to a project

Source: https://docs.volta.sh/guide

Saves the specified Node.js version in the project's package.json file for automatic switching.

```bash
volta pin node@20
```

--------------------------------

### Extend Root Configuration in Subprojects

Source: https://docs.volta.sh/advanced/workspaces

Subprojects inherit root settings by pointing the 'extends' key to the root package.json file.

```json
  {
    "volta": {
      "extends": "../../package.json"
    }
  }
```

```json
  {
    "volta": {
      "extends": "../../package.json"
    }
  }
```

--------------------------------

### Volta pin command syntax

Source: https://docs.volta.sh/reference/pin

Displays the usage, flags, and arguments for the volta pin command.

```text
Pins your project's runtime or package manager

USAGE:
    volta pin [FLAGS] <tool[@version]>...

FLAGS:
        --verbose    Enables verbose diagnostics
        --quiet      Prevents unnecessary output
    -h, --help       Prints help information

ARGS:
    <tool[@version]>...    Tools to pin, like `node@lts` or `yarn@^1.14`.
```

--------------------------------

### Define Root Volta Configuration

Source: https://docs.volta.sh/advanced/workspaces

The root package.json defines the base tool versions for the entire workspace.

```json
  {
    "volta": {
      "node": "12.16.1",
      "yarn": "1.22.4"
    }
  }
```

--------------------------------

### volta completions

Source: https://docs.volta.sh/reference/completions

Generates shell completion scripts for Volta. Users can specify the target shell and an optional output file.

```APIDOC
## volta completions

### Description
Generates command completion information for your shell. By default, it detects the current shell, but a specific shell can be provided as an argument.

### Usage
`volta completions [FLAGS] [OPTIONS] <shell>`

### Arguments
- **shell** (string) - Required - The shell to generate completions for. Possible values: zsh, bash, fish, powershell, elvish.

### Flags
- **-f, --force** - Optional - Write over an existing file, if any.
- **--verbose** - Optional - Enables verbose diagnostics.
- **--quiet** - Optional - Prevents unnecessary output.
- **-h, --help** - Optional - Prints help information.

### Options
- **-o, --output <out_file>** - Optional - File to write generated completions to. If not specified, output is written to stdout.
```

--------------------------------

### Pin project tool versions

Source: https://docs.volta.sh/guide/understanding

Configures specific Node and package manager versions for a project, stored in package.json.

```bash
volta pin node@20.16
volta pin yarn@1.19
```

```json
"volta": {
  "node": "20.16.0",
  "yarn": "1.19.2"
}
```

```bash
node --version # 20.16.0
yarn --version # 1.19.2
```

--------------------------------

### volta which

Source: https://docs.volta.sh/reference/which

Locates the actual binary that will be called by Volta for a given tool.

```APIDOC
## volta which

### Description
Locates the actual binary that will be called by Volta. This is useful for debugging which version of a tool (e.g., node or npm) is currently being invoked by the Volta shim.

### Usage
`volta which [FLAGS] <binary>`

### Arguments
- **binary** (string) - Required - The name of the binary to find (e.g., `node`, `npm`).

### Flags
- **--verbose** - Optional - Enables verbose diagnostics.
- **--quiet** - Optional - Prevents unnecessary output.
- **-h, --help** - Optional - Prints help information.
```

--------------------------------

### Select Default Node Version

Source: https://docs.volta.sh/guide/getting-started

Commands to set the global default Node.js version used outside of specific projects.

```bash
volta install node@22.5.1
```

```bash
volta install node
```

--------------------------------

### volta pin

Source: https://docs.volta.sh/reference/pin

Pins a specific version of a tool (Node or package manager) to the project's package.json file.

```APIDOC
## volta pin

### Description
Updates the project's package.json file to use the selected version of a tool such as Node, npm, or Yarn.

### Usage
volta pin [FLAGS] <tool[@version]>...

### Arguments
- **tool[@version]** (string) - Required - The tool and version to pin (e.g., node@lts, yarn@^1.14).

### Flags
- **--verbose** - Optional - Enables verbose diagnostics.
- **--quiet** - Optional - Prevents unnecessary output.
- **-h, --help** - Optional - Prints help information.
```

--------------------------------

### Remove Volta directory on Unix

Source: https://docs.volta.sh/advanced/uninstall

Deletes the entire ~/.volta directory to remove Volta binaries and data.

```bash
rm -rf ~/.volta
```
Tokens:
Raw