Command reference

Every command, subcommand and flag of Gritpack 1.2.63, generated from the program's own help. For an explanation with examples, start from the guide.

Generated from gritpack help and every --helpOld command names still work for now, with a notice; this reference lists only the current ones

Install, build and publish packages for Rust, npm, Go, C/C++ and Gritpack.

gritpack [OPTIONS] [COMMAND]

Project commands

gritpack init
Create a new gritpack.toml project manifest
gritpack add
Add a dependency to gritpack.toml and install it
gritpack remove
Remove an installed package
gritpack sync
Install what gritpack.toml and gritpack.lock call for, and nothing else
gritpack update
Update packages to the newest versions gritpack.toml allows
gritpack upgrade
Raise dependency requirements to the newest versions and install them
gritpack outdated
Show dependencies that have newer versions
gritpack list
List packages in the current lock file
gritpack why
Explain why an installed package is present
gritpack verify
Check that installed packages match gritpack.toml and gritpack.lock
gritpack doctor
Check this project's Gritpack setup and explain any problems
gritpack setup
Set up this project's Cargo, npm or Go to fetch packages from your hub
gritpack workspace
Work with a workspace of several packages developed together

Package commands

gritpack search
Search a hub for packages
gritpack info
Show a package and its available versions
gritpack publish
Publish the package or workspace in a directory, or a package file
gritpack package
Yank or deprecate a published version

Application commands

gritpack install
Install an application for your user from a hub
gritpack uninstall
Remove an application installed for your user
gritpack app
Install, list, upgrade and locate applications installed for your user

Account commands

gritpack login
Log in to a hub and save the credential it issues
gritpack auth
List, switch, renew and remove your hub logins
gritpack scope
Claim a package scope

Ecosystem commands

gritpack cargo
Set up and check Cargo for the hub's Cargo registry
gritpack npm
Set up and check npm for the hub's npm registry
gritpack go
Set up Go for the hub, and package and publish Go modules
gritpack c
Check C/C++ packages and use them from CMake, pkg-config or a compiler

Advanced commands

gritpack publication
Publish several packages step by step: plan, verify, publish
gritpack pack
Build a package file from a directory with gritpack.toml
gritpack cache
Inspect, check and clean the shared cache of downloaded packages
gritpack bundle
Carry a lock file's packages to another machine in a signed bundle
gritpack slice
Publish a signed bundle's packages as a static repository or to a hub
gritpack evidence
Inspect and check the signed records a hub keeps about packages
gritpack installer
Build downloads that install an application, and Gritpack if needed

Tool integration

gritpack api
Serve verified local package facts to compilers and other tools
gritpack mcp
Serve read-only facts about installed packages to AI tools over MCP
gritpack sources
Give compilers the source files of modules and their dependencies
gritpack graph
Ask a hub how the modules and files of its packages depend on each other

Hub administration

gritpack admin
Manage the hub: users, scopes, license rules and the audit log

Additional commands

gritpack alias
Make, list and remove your own short names for commands
gritpack completion
Print a shell completion script
gritpack version
Show the version, platform and where Gritpack is installed

Help topics

gritpack help environment
Environment variables Gritpack reads
gritpack help exit-codes
What each exit code means
gritpack help formatting
JSON output, and how to script Gritpack
gritpack help profiles
Where logins and settings are kept

Options for every command

--copyrightPrint copyright and license summary (SPDX-equivalent lines)
--licensePrint the full Frogfish Binary License 1.0
--error-format <ERROR_FORMAT>Format of error messages on standard errorEnvironment: GRITPACK_ERROR_FORMAT · Default: human · Values: human, json
-h, --helpPrint help
-V, --versionPrint version