The Gritpack guide

Current for Gritpack 1.2.63. This is the place to start: it teaches how to get packages, publish your own, install applications, work with a team on a private hub, and look after that hub, one step at a time.

Source: docs/guide/Every command checked against the release, examples run for real

You do not need to read it all. Each part ends by saying who is finished and can stop there.

Reading paths

  • I want to use packages. Chapters 1 to 9, then the chapter for your language (10 to 13).
  • I want to publish a package. Chapters 1 to 5, then 16 to 19, then 20 to 22 for your account and scope.
  • I want to install an application, or ship one. Chapters 2, 14 and 15.
  • My team works on a private hub. Chapters 20 to 26.
  • I write scripts and CI jobs. Chapters 27 to 30.
  • I look after a hub for my team. Chapters 31 and 32.
  • Something is wrong. Chapter 33, by symptom.
  • I know Cargo, npm or Go already. Chapter 34 maps what you know.

The chapters

Start here

Using packages

Each ecosystem

Applications

Publishing

Accounts and teams

Workspaces and releases

Trust

Scripting and automation

Hub administration

When you need help

Hubs in this guide

The public hub is get.gritpack.org. Anyone can search it and install from it without an account. Private hubs are run for teams by Frogfish, as a service or on the team's own premises under a written agreement; you use one when its administrator invites you. The examples call a private hub packages.example.com, its account ada@example.com and its scope @ada. Output is real output from Gritpack 1.2.63, shortened where it was long, with the test hub's address replaced by packages.example.com.

The command reference

Every command, subcommand and flag is in the command reference, generated from gritpack help and each command's --help. On your own machine, gritpack <command> --help shows the same text.