packwiz

https://packwiz.infra.link/
Admin
packwiz is a command-line tool for creating and managing Minecraft modpacks using Git-friendly TOML...
Tokens:18,341
Snippets:196
Trust Score:5.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run packwiz-installer on a Server

Source: https://packwiz.infra.link/tutorials/installing/packwiz-installer

Execute this command in a server environment to install mods without a GUI.

```bash
java -jar packwiz-installer-bootstrap.jar -g -s server https://[your-server]/pack.toml
```

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

### Install Packwiz from Source using Go

Source: https://packwiz.infra.link/installation

Use this command to install the latest version of Packwiz directly from its GitHub repository. Ensure you have Go version 1.19 or newer installed.

```bash
go install github.com/packwiz/packwiz@latest
```

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

### Configure MultiMC Pre-launch Command

Source: https://packwiz.infra.link/tutorials/installing/packwiz-installer

Use this command in the MultiMC instance settings to trigger the installer before the game launches.

```bash
"$INST_JAVA" -jar packwiz-installer-bootstrap.jar https://[your-server]/pack.toml
```

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

### Persist completions for new sessions

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/zsh

Installs the completion script to the appropriate directory for Linux or macOS.

```bash
packwiz completion zsh > "${fpath[1]}/_packwiz"
```

```bash
packwiz completion zsh > $(brew --prefix)/share/zsh/site-functions/_packwiz
```

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

### Install Fish Completions Permanently

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/fish

To enable Packwiz autocompletion for all future fish shell sessions, redirect the output of the packwiz completion fish command to a file in the fish completions directory. A new shell session is required for the changes to take effect.

```bash
packwiz completion fish > ~/.config/fish/completions/packwiz.fish
```

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

### Load Bash Autocompletion for All Sessions (macOS)

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/bash

Save the output of `packwiz completion bash` to a file in `$(brew --prefix)/etc/bash_completion.d/` to enable autocompletion for all future bash sessions on macOS. A new shell must be started for this to take effect.

```bash
packwiz completion bash > $(brew --prefix)/etc/bash_completion.d/packwiz
```

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

### Load Bash Autocompletion for All Sessions (Linux)

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/bash

Save the output of `packwiz completion bash` to a file in `/etc/bash_completion.d/` to enable autocompletion for all future bash sessions on Linux. A new shell must be started for this to take effect.

```bash
packwiz completion bash > /etc/bash_completion.d/packwiz
```

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

### Load Bash Autocompletion for Current Session

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/bash

Source the output of `packwiz completion bash` to enable autocompletion in your current shell session. This command requires the 'bash-completion' package to be installed.

```bash
source <(packwiz completion bash)
```

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

### Run packwiz serve

Source: https://packwiz.infra.link/reference/commands/packwiz/serve

Basic syntax for executing the serve command.

```bash
packwiz serve [flags]
```

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

### Packwiz Open Command Help Options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/open

Displays help information for the 'open' command. Use this to see available flags and options for the command.

```bash
  -h, --help   help for open
```

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

### Initialize a new modpack

Source: https://packwiz.infra.link/tutorials/creating/getting-started

Creates the necessary pack.toml and index.toml files in the current directory.

```bash
packwiz init
```

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

### packwiz curseforge import

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/import

Imports a CurseForge modpack from a downloaded pack zip or an installed metadata JSON file.

```APIDOC
## POST /packwiz/curseforge/import

### Description
Import a curseforge modpack from a downloaded pack zip or an installed metadata json file.

### Method
POST

### Endpoint
/packwiz/curseforge/import

### Parameters
#### Query Parameters
- **modpack_path** (string) - Required - The path to the downloaded modpack zip file or metadata JSON file.
- **cache** (string) - Optional - The directory where packwiz will cache downloaded mods.
- **config** (string) - Optional - The config file to use.
- **meta_folder** (string) - Optional - The folder in which new metadata files will be added.
- **meta_folder_base** (string) - Optional - The base folder from which meta_folder will be resolved.
- **pack_file** (string) - Optional - The modpack metadata file to use.
- **yes** (boolean) - Optional - Accept all prompts with the default or "yes" option (non-interactive mode).

### Request Example
```json
{
  "modpack_path": "/path/to/your/modpack.zip",
  "cache": "/opt/buildhome/.cache/packwiz/cache",
  "config": "/opt/buildhome/.config/packwiz/.packwiz.toml",
  "meta_folder": "mods",
  "meta_folder_base": ".",
  "pack_file": "pack.toml",
  "yes": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful import.

#### Response Example
```json
{
  "message": "Modpack imported successfully."
}
```
```

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

### packwiz migrate help options

Source: https://packwiz.infra.link/reference/commands/packwiz/migrate

Displays the help menu for the migrate command.

```bash
  -h, --help   help for migrate
```

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

### Packwiz Settings Help

Source: https://packwiz.infra.link/reference/commands/packwiz/settings

Displays help information for the packwiz settings command.

```bash
  -h, --help   help for settings


```

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

### CLI Command: packwiz init

Source: https://packwiz.infra.link/reference/commands/packwiz/init

Initializes a new packwiz modpack project in the current directory.

```APIDOC
## packwiz init

### Description
Initialise a packwiz modpack. This command creates the necessary configuration files to start managing a Minecraft modpack.

### Method
CLI Command

### Parameters
#### Options
- **--author** (string) - Optional - The author of the modpack (omit to define interactively)
- **--fabric-latest** (boolean) - Optional - Automatically select the latest version of Fabric loader
- **--fabric-version** (string) - Optional - The Fabric loader version to use
- **--forge-latest** (boolean) - Optional - Automatically select the latest version of Forge
- **--forge-version** (string) - Optional - The Forge version to use
- **--index-file** (string) - Optional - The index file to use (default "index.toml")
- **--latest** (boolean) - Optional - Automatically select the latest version of Minecraft
- **--liteloader-latest** (boolean) - Optional - Automatically select the latest version of LiteLoader
- **--liteloader-version** (string) - Optional - The LiteLoader version to use
- **--mc-version** (string) - Optional - The Minecraft version to use
- **--modloader** (string) - Optional - The mod loader to use
- **--name** (string) - Optional - The name of the modpack
- **--neoforge-latest** (boolean) - Optional - Automatically select the latest version of NeoForge
- **--neoforge-version** (string) - Optional - The NeoForge version to use
- **--quilt-latest** (boolean) - Optional - Automatically select the latest version of Quilt loader
- **--quilt-version** (string) - Optional - The Quilt loader version to use
- **-r, --reinit** (boolean) - Optional - Recreate the pack file if it already exists
- **-s, --snapshot** (boolean) - Optional - Use the latest snapshot version with --latest
- **--version** (string) - Optional - The version of the modpack

#### Inherited Options
- **--cache** (string) - Optional - The directory where packwiz will cache downloaded mods
- **--config** (string) - Optional - The config file to use
- **--meta-folder** (string) - Optional - The folder in which new metadata files will be added
- **--meta-folder-base** (string) - Optional - The base folder from which meta-folder will be resolved
- **--pack-file** (string) - Optional - The modpack metadata file to use
- **-y, --yes** (boolean) - Optional - Accept all prompts with the default or "yes" option
```

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

### Packwiz Utils Help Options

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Displays help information for the packwiz utils command.

```bash
  -h, --help   help for utils

```

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

### Enable zsh completion

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/zsh

Initializes the zsh completion system in the user's configuration file.

```bash
echo "autoload -U compinit; compinit" >> ~/.zshrc
```

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

### Packwiz Configuration File Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Specifies the configuration file to use. Defaults to /opt/buildhome/.config/packwiz/.packwiz.toml.

```bash
      --config string             The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")

```

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

### Usage of packwiz modrinth add

Source: https://packwiz.infra.link/reference/commands/packwiz/modrinth/add

Basic syntax for adding a project via URL, slug, or search query.

```bash
packwiz modrinth add [URL|slug|search] [flags]
```

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

### Add Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/add

These options allow fine-grained control when adding projects, such as specifying a particular addon ID, category, file ID, or game.

```bash
--addon-id uint32   The CurseForge project ID to use
```

```bash
--category string   The category to add files from (slug, as stored in URLs); the category in the URL takes precedence
```

```bash
--file-id uint32    The CurseForge file ID to use
```

```bash
--game string       The game to add files from (slug, as stored in URLs); the game in the URL takes precedence (default "minecraft")
```

```bash
-h, --help              help for add
```

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

### Packwiz Migrate Loader Help Option

Source: https://packwiz.infra.link/reference/commands/packwiz/migrate/loader

Displays help information for the loader command.

```bash
packwiz migrate loader --help
```

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

### Import command options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/import

Help flag for the import command.

```bash
  -h, --help   help for import
```

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

### Modrinth command help options

Source: https://packwiz.infra.link/reference/commands/packwiz/modrinth

Displays the help information for the modrinth command.

```bash
  -h, --help   help for modrinth
```

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

### packwiz serve options

Source: https://packwiz.infra.link/reference/commands/packwiz/serve

Configuration flags for the serve command, including port selection and refresh behavior.

```bash
      --basic      Disable refreshing and allow all files in the directory, rather than just files listed in the index
  -h, --help       help for serve
  -p, --port int   The port to run the server on (default 8080)
  -r, --refresh    Automatically refresh the index file (default true)
```

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

### Command-specific options for add

Source: https://packwiz.infra.link/reference/commands/packwiz/modrinth/add

Flags used to specify project or version identifiers during the add process.

```bash
  -h, --help                      help for add
      --project-id string         The Modrinth project ID to use
      --version-filename string   The Modrinth version filename to use
      --version-id string         The Modrinth version ID to use
```

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

### Command usage

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/zsh

Basic syntax for the zsh completion command.

```bash
packwiz completion zsh [flags]
```

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

### packwiz pin Options

Source: https://packwiz.infra.link/reference/commands/packwiz/pin

Available options for the packwiz pin command, including help.

```bash
  -h, --help   help for pin
```

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

### Packwiz Global Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/detect

These options are inherited from parent commands and can be used with 'detect'. They control caching, configuration, metadata folders, and pack files.

```bash
      --cache string              The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")

```

```bash
      --config string             The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")

```

```bash
      --meta-folder string        The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)

```

```bash
      --meta-folder-base string   The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")

```

```bash
      --pack-file string          The modpack metadata file to use (default "pack.toml")

```

```bash
  -y, --yes                       Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

```

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

### Add Project from CurseForge

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/add

Use this command to add a project from a CurseForge URL, slug, or search query. Flags can specify addon ID, category, file ID, or game.

```bash
packwiz curseforge add [URL|slug|search] [flags]
```

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

### Open CurseForge Project Page

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/open

Use this command to open the project page for a specific CurseForge file in your web browser. Replace '[name]' with the actual name of the file.

```bash
packwiz curseforge open [name] [flags]
```

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

### Load Fish Completions Temporarily

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/fish

To load completions in your current shell session, pipe the output of the packwiz completion fish command to the source command. This is useful for testing or immediate use without permanent changes.

```bash
packwiz completion fish | source
```

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

### Usage of acceptable-versions command

Source: https://packwiz.infra.link/reference/commands/packwiz/settings/acceptable-versions

Basic syntax for executing the acceptable-versions command.

```bash
packwiz settings acceptable-versions [flags]
```

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

### Packwiz CurseForge Help Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Use this option to display help information for the packwiz curseforge command.

```bash
  -h, --help   help for curseforge

```

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

### Import CurseForge modpack command syntax

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/import

Basic command structure for importing a modpack.

```bash
packwiz curseforge import [modpack path] [flags]
```

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

### Command options

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/zsh

Available flags for the zsh completion command.

```text
  -h, --help              help for zsh
      --no-descriptions   disable completion descriptions
```

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

### Packwiz Detect Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/detect

These are the specific options available for the 'detect' command.

```bash
  -h, --help   help for detect

```

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

### Common packwiz CLI commands

Source: https://packwiz.infra.link/tutorials/creating/getting-started

A summary of frequently used commands for managing mods and exporting modpacks.

```bash
packwiz init
packwiz curseforge import [zip path]
packwiz refresh
packwiz curseforge install [mod]
packwiz modrinth install [mod]
packwiz update [mod]
packwiz update --all
packwiz curseforge export
packwiz modrinth export
packwiz curseforge detect
packwiz --help
```

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

### Packwiz Migrate Loader Options

Source: https://packwiz.infra.link/reference/commands/packwiz/migrate/loader

Configuration options for the packwiz migrate loader command, including cache directory, config file path, and metadata folder settings.

```bash
packwiz migrate loader --cache string
  The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
--config string
  The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
--meta-folder string
  The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string
  The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
-y, --yes
  Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```

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

### Packwiz Inherited Meta-Folder Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Defines the folder for new metadata files. Defaults to a category-based folder, or the current directory if the category is unknown.

```bash
      --meta-folder string       The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)

```

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

### See Also: Packwiz CurseForge Command

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/detect

This section provides a link to the main command for managing CurseForge-based mods.

```bash
  * packwiz curseforge - Manage curseforge-based mods

```

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

### Run Packwiz CurseForge Detect

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/detect

Use this command to detect .jar files in your mods folder. This is an experimental feature.

```bash
packwiz curseforge detect [flags]
```

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

### Packwiz Meta Folder Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Defines the folder for new metadata files, defaulting to a category-based folder.

```bash
      --meta-folder string        The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)

```

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

### Define external file metadata in .pw.toml

Source: https://packwiz.infra.link/tutorials/creating/adding-mods

Create a .pw.toml file to manually define external mods or files that are not hosted on CurseForge or Modrinth.

```toml
name = "Flamingo"
filename = "flamingo.jar"
side = "both"

[download]
url = "https://example.com/flamingo.jar"

# A number of tools can generate the hash for you, including 7-zip and sha256sum
# packwiz supports a number of hashes, including sha256, sha512, sha1 and md5
hash-format = "sha256"
hash = "b22d1d8fe5752533954028172c9bf3ac01b57f40c82946a3e7b1eaff389e2b87"
```

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

### Command options for packwiz update

Source: https://packwiz.infra.link/reference/commands/packwiz/update

Available flags to control the update process, including updating all files or displaying help.

```bash
  -a, --all    Update all external files
  -h, --help   help for update
```

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

### Packwiz Inherited Config Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Specifies the configuration file to use. Defaults to /opt/buildhome/.config/packwiz/.packwiz.toml.

```bash
      --config string            The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")

```

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

### Packwiz URL Add Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/url/add

These options modify the behavior of the `packwiz url add` command. The `--force` flag adds a file even if packwiz could handle it differently, while `--meta-name` allows custom naming for the metadata file.

```bash
--force               Add a file even if the download URL is supported by packwiz in an alternative command (which may support dependencies and updates)
```

```bash
-h, --help               help for add
```

```bash
--meta-name string   Filename to use for the created metadata file (defaults to a name generated from the name you supply)
```

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

### packwiz settings

Source: https://packwiz.infra.link/reference/commands/packwiz/settings

Manage pack settings for the packwiz CLI tool.

```APIDOC
## packwiz settings

### Description
Manage pack settings for the current project.

### Options
- **-h, --help** - Displays help information for the settings command.

### Inherited Options
- **--cache** (string) - The directory where packwiz will cache downloaded mods (default: "/opt/buildhome/.cache/packwiz/cache").
- **--config** (string) - The config file to use (default: "/opt/buildhome/.config/packwiz/.packwiz.toml").
- **--meta-folder** (string) - The folder in which new metadata files will be added.
- **--meta-folder-base** (string) - The base folder from which meta-folder will be resolved (default: ".").
- **--pack-file** (string) - The modpack metadata file to use (default: "pack.toml").
- **-y, --yes** - Accept all prompts with the default or "yes" option (non-interactive mode).
```

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

### CLI: packwiz settings acceptable-versions

Source: https://packwiz.infra.link/reference/commands/packwiz/settings/acceptable-versions

Manage the list of acceptable Minecraft versions for the modpack.

```APIDOC
## CLI Command: packwiz settings acceptable-versions

### Description
Manages the list of acceptable Minecraft versions for the pack. The versions must be provided as a comma-separated list.

### Options
- **-a, --add** (flag) - Add a version to the list
- **-r, --remove** (flag) - Remove a version from the list
- **-h, --help** (flag) - Help for acceptable-versions

### Inherited Options
- **--cache** (string) - The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config** (string) - The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder** (string) - The folder in which new metadata files will be added
- **--meta-folder-base** (string) - The base folder from which meta-folder will be resolved (default ".")
- **--pack-file** (string) - The modpack metadata file to use (default "pack.toml")
- **-y, --yes** (flag) - Accept all prompts with the default or "yes" option
```

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

### Usage syntax for packwiz update

Source: https://packwiz.infra.link/reference/commands/packwiz/update

Basic command structure for updating modpack files.

```bash
packwiz update [name] [flags]
```

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

### Usage of packwiz refresh

Source: https://packwiz.infra.link/reference/commands/packwiz/refresh

Basic syntax for executing the refresh command.

```bash
packwiz refresh [flags]
```

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

### Packwiz Inherited Meta-Folder-Base Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Sets the base folder for resolving meta-folders. Defaults to the current directory.

```bash
      --meta-folder-base string  The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")

```

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

### packwiz curseforge open

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/open

Opens the project page for a CurseForge file in your browser.

```APIDOC
## packwiz curseforge open

### Description
Open the project page for a CurseForge file in your browser.

### Method
Not Applicable (CLI Command)

### Endpoint
Not Applicable (CLI Command)

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the CurseForge file to open.

#### Query Parameters
None

#### Request Body
None

### Options
- **-h, --help**: help for open

### Inherited Options
- **--cache string**: The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config string**: The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder string**: The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
- **--meta-folder-base string**: The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
- **--pack-file string**: The modpack metadata file to use (default "pack.toml")
- **-y, --yes**: Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

### SEE ALSO
* packwiz curseforge - Manage curseforge-based mods
```

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

### Export Options

Source: https://packwiz.infra.link/reference/commands/packwiz/modrinth/export

Customize the export process with these options. The `--output` flag is crucial for specifying the destination file.

```bash
  -h, --help              help for export
  -o, --output string     The file to export the modpack to
      --restrictDomains   Restricts domains to those allowed by modrinth.com (default true)
```

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

### packwiz remove command help options

Source: https://packwiz.infra.link/reference/commands/packwiz/remove

Help options available for the packwiz remove command. Use -h or --help to display these.

```bash
  -h, --help   help for remove

```

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

### Usage of packwiz unpin

Source: https://packwiz.infra.link/reference/commands/packwiz/unpin

Basic syntax for executing the unpin command.

```bash
packwiz unpin [flags]
```

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

### Option Object

Source: https://packwiz.infra.link/reference/pack-format/mod-toml

Configuration for optional mod states.

```APIDOC
## Option Object

### Parameters
#### Request Body
- **optional** (boolean) - Required - Whether or not the mod is optional.
- **default** (boolean) - Optional - If true, the mod will be enabled by default.
- **description** (string) - Optional - A description displayed to the user when they select optional mods.
```

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

### Packwiz Pack File Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Specifies the modpack metadata file to use. Defaults to pack.toml.

```bash
      --pack-file string          The modpack metadata file to use (default "pack.toml")

```

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

### Packwiz Yes Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Accepts all prompts with the default or 'yes' option for non-interactive mode. Use with caution as it may select unwanted search results.

```bash
  -y, --yes                       Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

```

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

### Packwiz Meta Folder Base Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Sets the base folder for resolving meta-folders, defaulting to the current directory.

```bash
      --meta-folder-base string   The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")

```

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

### Packwiz Options

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/bash

Common options for the packwiz command, including cache directory, configuration file path, and metadata folder settings. The `--yes` flag enables non-interactive mode.

```bash
  -h, --help              help for bash
      --no-descriptions   disable completion descriptions
```

```bash
      --cache string              The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
      --config string             The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
      --meta-folder string        The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
      --meta-folder-base string   The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
  -y, --yes                       Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```

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

### Packwiz URL Add Command Usage

Source: https://packwiz.infra.link/reference/commands/packwiz/url/add

Use this command to add an external file from a direct download link. This is useful for sites not directly supported by packwiz. Specify the name for the entry, the direct download URL, and any relevant flags.

```bash
packwiz url add [name] [url] [flags]
```

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

### Import a CurseForge modpack

Source: https://packwiz.infra.link/tutorials/creating/getting-started

Imports mods and files from a CurseForge .zip archive into the current directory.

```bash
packwiz curseforge import [zip path]
```

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

### Packwiz Completion Command Synopsis

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/fish

This is the general synopsis for generating Packwiz autocompletion scripts for the fish shell. Flags can be appended to modify the behavior of the completion script generation.

```bash
packwiz completion fish [flags]
```

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

### Command options for acceptable-versions

Source: https://packwiz.infra.link/reference/commands/packwiz/settings/acceptable-versions

Available flags to modify or remove Minecraft versions from the acceptable list.

```bash
  -a, --add      Add a version to the list
  -h, --help     help for acceptable-versions
  -r, --remove   Remove a version from the list
```

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

### Packwiz Global Options

Source: https://packwiz.infra.link/reference/commands/packwiz

Global options that can be used with any packwiz command.

```APIDOC
## Packwiz Global Options

### Description
These are global options that can be applied to any packwiz command to modify its behavior.

### Parameters
#### Global Options
- **--cache** (string) - The directory where packwiz will cache downloaded mods. Defaults to `/opt/buildhome/.cache/packwiz/cache`.
- **--config** (string) - The config file to use. Defaults to `/opt/buildhome/.config/packwiz/.packwiz.toml`.
- **-h, --help** - Displays help information for packwiz.
- **--meta-folder** (string) - The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc.). If the category is unknown, the current directory is used.
- **--meta-folder-base** (string) - The base folder from which `meta-folder` will be resolved, defaulting to the current directory. This allows for organizing mods/etc. in subfolders while maintaining default behavior. Defaults to `.`.
- **--pack-file** (string) - The modpack metadata file to use. Defaults to `pack.toml`.
- **-y, --yes** - Accepts all prompts with the default or "yes" option, enabling non-interactive mode. This may select unwanted options in search results.
```

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

### Download Object

Source: https://packwiz.infra.link/reference/pack-format/mod-toml

Details regarding the download source and integrity verification.

```APIDOC
## Download Object

### Parameters
#### Request Body
- **hash-format** (string) - Required - The hash algorithm (sha256, sha512, sha1, md5, murmur2).
- **hash** (string) - Required - The hash of the specified file.
- **url** (string) - Required - The absolute URI to download the mod from.
```

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

### Exporting a CurseForge modpack

Source: https://packwiz.infra.link/tutorials/hosting/curseforge

Run this command in your pack folder to generate a .zip file ready for upload to CurseForge.

```bash
packwiz curseforge export
```

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

### packwiz global options

Source: https://packwiz.infra.link/reference/commands/packwiz/remove

Options inherited from parent commands that can be used with packwiz remove. These control caching, configuration files, and metadata handling.

```bash
--cache string              The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
--config string             The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
--meta-folder string        The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
--meta-folder-base string   The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
-y, --yes                   Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

```

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

### Packwiz Cache Directory Option

Source: https://packwiz.infra.link/reference/commands/packwiz/utils

Specifies the directory for caching downloaded mods. Defaults to /opt/buildhome/.cache/packwiz/cache.

```bash
      --cache string              The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")

```

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

### Packwiz Inherited Pack-File Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Specifies the modpack metadata file to use. Defaults to pack.toml.

```bash
      --pack-file string         The modpack metadata file to use (default "pack.toml")

```

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

### Configure acceptable game versions in pack.toml

Source: https://packwiz.infra.link/tutorials/creating/adding-mods

Add this configuration to the bottom of your pack.toml file to specify which Minecraft versions are compatible with your modpack.

```toml
[options]
acceptable-game-versions = ["1.16", "1.16.1", "1.16.2", "1.16.3", "1.16.4"]
```

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

### packwiz curseforge detect

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/detect

Detects .jar files in the mods folder. This is an experimental feature.

```APIDOC
## packwiz curseforge detect

### Description
Detect .jar files in the mods folder (experimental).

### Usage
`packwiz curseforge detect [flags]`

### Options
- **-h, --help** - Help for detect

### Inherited Options
- **--cache** (string) - The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config** (string) - The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder** (string) - The folder in which new metadata files will be added
- **--meta-folder-base** (string) - The base folder from which meta-folder will be resolved (default ".")
- **--pack-file** (string) - The modpack metadata file to use (default "pack.toml")
- **-y, --yes** - Accept all prompts with the default or "yes" option (non-interactive mode)
```

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

### PowerShell completion options

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/powershell

Flags available specifically for the powershell completion command.

```bash
  -h, --help              help for powershell
      --no-descriptions   disable completion descriptions
```

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

### Fish Completion Options

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/fish

These are specific options available when generating the fish completion script. The --no-descriptions flag disables the inclusion of descriptions in the autocompletion suggestions.

```bash
  -h, --help              help for fish
      --no-descriptions   disable completion descriptions
```

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

### Load PowerShell completions

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/powershell

Commands to load autocompletion for the current session or persist it in the PowerShell profile.

```powershell
packwiz completion powershell | Out-String | Invoke-Expression
```

```powershell
packwiz completion powershell [flags]
```

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

### mod.pw.toml Structure

Source: https://packwiz.infra.link/reference/pack-format/mod-toml

The root structure of the mod.pw.toml metadata file.

```APIDOC
## mod.pw.toml Structure

### Description
A metadata file which references an external file from a URL, allowing for side-only mods, optional mods, and update tracking.

### Parameters
#### Request Body
- **download** (object) - Required - Information about how to download this mod.
- **filename** (string) - Required - The destination path of the mod file, relative to this file.
- **name** (string) - Required - The name of the mod.
- **option** (object) - Optional - Information about the optional state of this mod.
- **side** (string) - Optional - The side on which this mod should be installed (both, client, server).
- **update** (object) - Optional - Information about how to update the download details of this mod.
```

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

### Inherited Parent Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/add

These options are inherited from parent commands and control caching, configuration, metadata folder behavior, and non-interactive mode.

```bash
--cache string              The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
```

```bash
--config string             The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
```

```bash
--meta-folder string        The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
```

```bash
--meta-folder-base string   The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
```

```bash
--pack-file string          The modpack metadata file to use (default "pack.toml")
```

```bash
-y, --yes                       Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results
```

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

### Packwiz Migrate Command Overview

Source: https://packwiz.infra.link/reference/commands/packwiz/migrate/loader

This command is part of the packwiz migrate functionality, which is used to update both Minecraft and modloader versions.

```bash
packwiz migrate
```

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

### Packwiz Migrate Loader Command Usage

Source: https://packwiz.infra.link/reference/commands/packwiz/migrate/loader

This command is used to migrate your modloader to a newer version. Specify 'latest' or 'recommended' for automatic version selection.

```bash
packwiz migrate loader [version|latest|recommended] [flags]
```

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

### Packwiz Subcommands

Source: https://packwiz.infra.link/reference/commands/packwiz

Available subcommands for packwiz, each performing a specific task related to modpack management.

```APIDOC
## Packwiz Subcommands

### Description
Packwiz offers various subcommands to manage Minecraft modpacks. Each subcommand addresses a specific aspect of modpack creation and maintenance.

### Available Subcommands
- **packwiz completion**: Generate the autocompletion script for the specified shell.
- **packwiz curseforge**: Manage curseforge-based mods.
- **packwiz init**: Initialize a packwiz modpack.
- **packwiz list**: List all the mods in the modpack.
- **packwiz migrate**: Migrate your Minecraft and loader versions to newer versions.
- **packwiz modrinth**: Manage modrinth-based mods.
- **packwiz pin**: Pin a file so it does not get updated automatically.
- **packwiz refresh**: Refresh the index file.
- **packwiz remove**: Remove an external file from the modpack; equivalent to manually removing the file and running `packwiz refresh`.
- **packwiz serve**: Run a local development server.
- **packwiz settings**: Manage pack settings.
- **packwiz unpin**: Unpin a file so it receives updates.
- **packwiz update**: Update an external file (or all external files) in the modpack.
- **packwiz url**: Add external files from a direct download link, for sites that are not directly supported by packwiz.
- **packwiz utils**: Utilities for managing packwiz itself.
```

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

### packwiz pin Command

Source: https://packwiz.infra.link/reference/commands/packwiz/pin

The 'packwiz pin' command allows users to mark specific files, preventing them from being automatically updated by packwiz. This is useful for custom configurations or files that should remain unchanged.

```APIDOC
## packwiz pin Command

### Description

Pin a file so it does not get updated automatically.

### Method

CLI Command

### Endpoint

N/A (This is a command-line tool)

### Parameters

#### Command Arguments

- **[flags]** (string) - Optional - Flags to modify the behavior of the pin command.

#### Options

- **-h, --help** (bool) - help for pin

#### Inherited Options

- **--cache** (string) - The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config** (string) - The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder** (string) - The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
- **--meta-folder-base** (string) - The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
- **--pack-file** (string) - The modpack metadata file to use (default "pack.toml")
- **-y, --yes** (bool) - Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

### Request Example

```bash
packwiz pin
packwiz pin --cache /path/to/cache
packwiz pin -y
```

### Response

This command does not produce a structured response. It modifies the state of the packwiz project by pinning files.
```

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

### Load completions in current session

Source: https://packwiz.infra.link/reference/commands/packwiz/completion/zsh

Loads the generated completion script into the active shell session.

```bash
source <(packwiz completion zsh); compdef _packwiz packwiz
```

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

### Packwiz Inherited Cache Option

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge

Specifies the directory for caching downloaded mods. Defaults to /opt/buildhome/.cache/packwiz/cache.

```bash
      --cache string             The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")

```

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

### packwiz modrinth add

Source: https://packwiz.infra.link/reference/commands/packwiz/modrinth/add

Adds a project from a Modrinth URL, slug/project ID, or search to your packwiz modpack.

```APIDOC
## packwiz modrinth add

### Description
Add a project from a Modrinth URL, slug/project ID or search.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Command Usage
```
packwiz modrinth add [URL|slug|search] [flags]
```

### Options
#### Command-Specific Options
- **-h, --help** (boolean) - help for add
- **--project-id** (string) - The Modrinth project ID to use
- **--version-filename** (string) - The Modrinth version filename to use
- **--version-id** (string) - The Modrinth version ID to use

#### Inherited Options
- **--cache** (string) - The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config** (string) - The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder** (string) - The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used)
- **--meta-folder-base** (string) - The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".")
- **--pack-file** (string) - The modpack metadata file to use (default "pack.toml")
- **-y, --yes** (boolean) - Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results

### Request Example
```
packwiz modrinth add "curseforge:fabric-api"
packwiz modrinth add --project-id "AbCdEfGh"
```

### Response
N/A (CLI Command Output)

### Error Handling
N/A (CLI Command Errors)
```

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

### packwiz curseforge add

Source: https://packwiz.infra.link/reference/commands/packwiz/curseforge/add

Adds a project from a CurseForge URL, slug, ID, or search query to your packwiz project.

```APIDOC
## packwiz curseforge add

### Description
Add a project from a CurseForge URL, slug, ID or search.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Options
- **--addon-id** (uint32): The CurseForge project ID to use.
- **--category** (string): The category to add files from (slug, as stored in URLs); the category in the URL takes precedence.
- **--file-id** (uint32): The CurseForge file ID to use.
- **--game** (string): The game to add files from (slug, as stored in URLs); the game in the URL takes precedence (default "minecraft").
- **-h, --help**: help for add

### Options inherited from parent commands
- **--cache** (string): The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache").
- **--config** (string): The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml").
- **--meta-folder** (string): The folder in which new metadata files will be added, defaulting to a folder based on the category (mods, resourcepacks, etc; if the category is unknown the current directory is used).
- **--meta-folder-base** (string): The base folder from which meta-folder will be resolved, defaulting to the current directory (so you can put all mods/etc in a subfolder while still using the default behaviour) (default ".").
- **--pack-file** (string): The modpack metadata file to use (default "pack.toml").
- **-y, --yes**: Accept all prompts with the default or "yes" option (non-interactive mode) - may pick unwanted options in search results.

### SEE ALSO
* packwiz curseforge - Manage curseforge-based mods
```

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

### packwiz list

Source: https://packwiz.infra.link/reference/commands/packwiz/list

Lists all mods in the modpack with optional filtering and version display.

```APIDOC
## packwiz list

### Description
List all the mods in the modpack.

### Options
- **-h, --help** (flag) - Optional - Help for list
- **-s, --side** (string) - Optional - Filter mods by side (e.g., client or server)
- **-v, --version** (flag) - Optional - Print name and version

### Inherited Options
- **--cache** (string) - Optional - The directory where packwiz will cache downloaded mods (default "/opt/buildhome/.cache/packwiz/cache")
- **--config** (string) - Optional - The config file to use (default "/opt/buildhome/.config/packwiz/.packwiz.toml")
- **--meta-folder** (string) - Optional - The folder in which new metadata files will be added
- **--meta-folder-base** (string) - Optional - The base folder from which meta-folder will be resolved (default ".")
- **--pack-file** (string) - Optional - The modpack metadata file to use (default "pack.toml")
- **-y, --yes** (flag) - Optional - Accept all prompts with the default or "yes" option
```

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

### Command options for unpin

Source: https://packwiz.infra.link/reference/commands/packwiz/unpin

Available flags specific to the unpin command.

```bash
  -h, --help   help for unpin
```

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

### Refresh Command Options

Source: https://packwiz.infra.link/reference/commands/packwiz/refresh

Specific flags available for the refresh command.

```bash
      --build   Only has an effect in no-internal-hashes mode: generates internal hashes for distribution with packwiz-installer
  -h, --help    help for refresh
```
Tokens:
Raw