more docs fixes
All checks were successful
Actions / Build and Upload Export Files (push) Successful in 7s
Actions / Autotagger (push) Successful in 8s
Actions / Build Documentation (push) Successful in 20s

This commit is contained in:
SeaswimmerTheFsh 2024-05-09 14:42:17 -04:00
parent 3606045b41
commit 7e0d17578c
Signed by: cswimr
GPG key ID: 5D671B5D03D65A7F
32 changed files with 105 additions and 105 deletions

View file

@ -1,8 +1,8 @@
## packwiz completion bash
# packwiz completion bash
Generate the autocompletion script for bash
### Synopsis
## Synopsis
Generate the autocompletion script for the bash shell.
@ -15,11 +15,11 @@ To load completions in your current shell session:
To load completions for every new session, execute once:
#### Linux:
### Linux
packwiz completion bash > /etc/bash_completion.d/packwiz
#### macOS:
### macOS
packwiz completion bash > $(brew --prefix)/etc/bash_completion.d/packwiz
@ -30,14 +30,14 @@ You will need to start a new shell for this setup to take effect.
packwiz completion bash
```
### Options
## Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,8 +1,8 @@
## packwiz completion fish
# packwiz completion fish
Generate the autocompletion script for fish
### Synopsis
## Synopsis
Generate the autocompletion script for the fish shell.
@ -21,14 +21,14 @@ You will need to start a new shell for this setup to take effect.
packwiz completion fish [flags]
```
### Options
## Options
```
-h, --help help for fish
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,20 +1,20 @@
## packwiz completion
# packwiz completion
Generate the autocompletion script for the specified shell
### Synopsis
## Synopsis
Generate the autocompletion script for packwiz for the specified shell.
See each sub-command's help for details on how to use the generated script.
### Options
## Options
```
-h, --help help for completion
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,8 +1,8 @@
## packwiz completion powershell
# packwiz completion powershell
Generate the autocompletion script for powershell
### Synopsis
## Synopsis
Generate the autocompletion script for powershell.
@ -18,14 +18,14 @@ to your powershell profile.
packwiz completion powershell [flags]
```
### Options
## Options
```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,8 +1,8 @@
## packwiz completion zsh
# packwiz completion zsh
Generate the autocompletion script for zsh
### Synopsis
## Synopsis
Generate the autocompletion script for the zsh shell.
@ -17,11 +17,11 @@ To load completions in your current shell session:
To load completions for every new session, execute once:
#### Linux:
### Linux:
packwiz completion zsh > "${fpath[1]}/_packwiz"
#### macOS:
### macOS:
packwiz completion zsh > $(brew --prefix)/share/zsh/site-functions/_packwiz
@ -32,14 +32,14 @@ You will need to start a new shell for this setup to take effect.
packwiz completion zsh [flags]
```
### Options
## Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz curseforge add
# packwiz curseforge add
Add a project from a CurseForge URL, slug, ID or search
@ -6,7 +6,7 @@ Add a project from a CurseForge URL, slug, ID or search
packwiz curseforge add [URL|slug|search] [flags]
```
### Options
## Options
```
--addon-id uint32 The CurseForge project ID to use
@ -16,7 +16,7 @@ packwiz curseforge add [URL|slug|search] [flags]
-h, --help help for add
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz curseforge detect
# packwiz curseforge detect
Detect .jar files in the mods folder (experimental)
@ -6,13 +6,13 @@ Detect .jar files in the mods folder (experimental)
packwiz curseforge detect [flags]
```
### Options
## Options
```
-h, --help help for detect
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz curseforge export
# packwiz curseforge export
Export the current modpack into a .zip for curseforge
@ -6,7 +6,7 @@ Export the current modpack into a .zip for curseforge
packwiz curseforge export [flags]
```
### Options
## Options
```
-h, --help help for export
@ -14,7 +14,7 @@ packwiz curseforge export [flags]
-s, --side string The side to export mods with (default "client")
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz curseforge import
# packwiz curseforge import
Import a curseforge modpack from a downloaded pack zip or an installed metadata json file
@ -6,13 +6,13 @@ Import a curseforge modpack from a downloaded pack zip or an installed metadata
packwiz curseforge import [modpack path] [flags]
```
### Options
## Options
```
-h, --help help for import
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz curseforge
# packwiz curseforge
Manage curseforge-based mods
### Options
## Options
```
-h, --help help for curseforge
```
### Options inherited from parent commands
###Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz curseforge open
# packwiz curseforge open
Open the project page for a CurseForge file in your browser
@ -6,13 +6,13 @@ Open the project page for a CurseForge file in your browser
packwiz curseforge open [name] [flags]
```
### Options
## Options
```
-h, --help help for open
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,8 +1,8 @@
## packwiz
# packwiz
A command line tool for creating Minecraft modpacks
### Options
## Options
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz init
# packwiz init
Initialise a packwiz modpack
@ -6,7 +6,7 @@ Initialise a packwiz modpack
packwiz init [flags]
```
### Options
## Options
```
--author string The author of the modpack (omit to define interactively)
@ -31,7 +31,7 @@ packwiz init [flags]
--version string The version of the modpack (omit to define interactively)
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz list
# packwiz list
List all the mods in the modpack
@ -6,7 +6,7 @@ List all the mods in the modpack
packwiz list [flags]
```
### Options
## Options
```
-h, --help help for list
@ -14,7 +14,7 @@ packwiz list [flags]
-v, --version Print name and version
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz migrate
# packwiz migrate
Migrate your Minecraft and loader versions to newer versions.
### Options
## Options
```
-h, --help help for migrate
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz migrate loader
# packwiz migrate loader
Migrate your modloader version to a newer version.
@ -6,13 +6,13 @@ Migrate your modloader version to a newer version.
packwiz migrate loader [version|latest|recommended] [flags]
```
### Options
## Options
```
-h, --help help for loader
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz migrate minecraft
# packwiz migrate minecraft
Migrate your Minecraft version to a newer version.
@ -6,13 +6,13 @@ Migrate your Minecraft version to a newer version.
packwiz migrate minecraft [version] [flags]
```
### Options
## Options
```
-h, --help help for minecraft
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz modrinth add
# packwiz modrinth add
Add a project from a Modrinth URL, slug/project ID or search
@ -6,7 +6,7 @@ Add a project from a Modrinth URL, slug/project ID or search
packwiz modrinth add [URL|slug|search] [flags]
```
### Options
## Options
```
-h, --help help for add
@ -15,7 +15,7 @@ packwiz modrinth add [URL|slug|search] [flags]
--version-id string The Modrinth version ID to use
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz modrinth export
# packwiz modrinth export
Export the current modpack into a .mrpack for Modrinth
@ -6,7 +6,7 @@ Export the current modpack into a .mrpack for Modrinth
packwiz modrinth export [flags]
```
### Options
## Options
```
-h, --help help for export
@ -14,7 +14,7 @@ packwiz modrinth export [flags]
--restrictDomains Restricts domains to those allowed by modrinth.com (default true)
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz modrinth
# packwiz modrinth
Manage modrinth-based mods
### Options
## Options
```
-h, --help help for modrinth
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz pin
# packwiz pin
Pin a file so it does not get updated automatically
@ -6,13 +6,13 @@ Pin a file so it does not get updated automatically
packwiz pin [flags]
```
### Options
## Options
```
-h, --help help for pin
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz refresh
# packwiz refresh
Refresh the index file
@ -6,14 +6,14 @@ Refresh the index file
packwiz refresh [flags]
```
### Options
## Options
```
--build Only has an effect in no-internal-hashes mode: generates internal hashes for distribution with packwiz-installer
-h, --help help for refresh
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz remove
# packwiz remove
Remove an external file from the modpack; equivalent to manually removing the file and running packwiz refresh
@ -6,13 +6,13 @@ Remove an external file from the modpack; equivalent to manually removing the fi
packwiz remove [flags]
```
### Options
## Options
```
-h, --help help for remove
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,8 +1,8 @@
## packwiz serve
# packwiz serve
Run a local development server
### Synopsis
## Synopsis
Run a local HTTP server for development, automatically refreshing the index when it is queried
@ -10,7 +10,7 @@ Run a local HTTP server for development, automatically refreshing the index when
packwiz serve [flags]
```
### Options
## Options
```
--basic Disable refreshing and allow all files in the directory, rather than just files listed in the index
@ -19,7 +19,7 @@ packwiz serve [flags]
-r, --refresh Automatically refresh the index file (default true)
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz settings acceptable-versions
# packwiz settings acceptable-versions
Manage your pack's acceptable Minecraft versions. This must be a comma seperated list of Minecraft versions, e.g. 1.16.3,1.16.4,1.16.5
@ -6,7 +6,7 @@ Manage your pack's acceptable Minecraft versions. This must be a comma seperated
packwiz settings acceptable-versions [flags]
```
### Options
## Options
```
-a, --add Add a version to the list
@ -14,7 +14,7 @@ packwiz settings acceptable-versions [flags]
-r, --remove Remove a version from the list
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz settings
# packwiz settings
Manage pack settings
### Options
## Options
```
-h, --help help for settings
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz unpin
# packwiz unpin
Unpin a file so it receives updates
@ -6,13 +6,13 @@ Unpin a file so it receives updates
packwiz unpin [flags]
```
### Options
## Options
```
-h, --help help for unpin
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz update
# packwiz update
Update an external file (or all external files) in the modpack
@ -6,14 +6,14 @@ Update an external file (or all external files) in the modpack
packwiz update [name] [flags]
```
### Options
## Options
```
-a, --all Update all external files
-h, --help help for update
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz url add
# packwiz url add
Add an external file from a direct download link, for sites that are not directly supported by packwiz
@ -6,7 +6,7 @@ Add an external file from a direct download link, for sites that are not directl
packwiz url add [name] [url] [flags]
```
### Options
## Options
```
--force Add a file even if the download URL is supported by packwiz in an alternative command (which may support dependencies and updates)
@ -14,7 +14,7 @@ packwiz url add [name] [url] [flags]
--meta-name string Filename to use for the created metadata file (defaults to a name generated from the name you supply)
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz url
# packwiz url
Add external files from a direct download link, for sites that are not directly supported by packwiz
### Options
## Options
```
-h, --help help for url
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,14 +1,14 @@
## packwiz utils
# packwiz utils
Utilities for managing packwiz itself
### Options
## Options
```
-h, --help help for utils
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")

View file

@ -1,4 +1,4 @@
## packwiz utils markdown
# packwiz utils markdown
Generate markdown documentation (that you might be reading right now!!)
@ -6,14 +6,14 @@ Generate markdown documentation (that you might be reading right now!!)
packwiz utils markdown [flags]
```
### Options
## Options
```
--dir string The destination directory to save docs in (default ".")
-h, --help help for markdown
```
### Options inherited from parent commands
## Options inherited from parent commands
```
--cache string The directory where packwiz will cache downloaded mods (default "/home/seasw/.cache/packwiz/cache")