Skip to content

docs: update install-package commands #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: update install-package commands #443

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcff20c
docs: update install-package commands
tbogosavljevic Jul 22, 2025
2f4fad6
Merge branch 'main' into docs/no-ref/install-package-flags
tbogosavljevic Jul 23, 2025
e57b31e
Merge branch 'main' into docs/no-ref/install-package-flags
tbogosavljevic Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 7 additions & 21 deletions docs/docs/reference/toolbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,36 +239,22 @@ $ checksum package-lock.json

## install-package {#install-package}

The `install-package` tool is used to manage Ubuntu packages you may need for your jobs. It downloads and caches packages in a way that can be quickly reinstalled over and over again in different jobs. This is a convenient tool, you can still use `sudo` to install packages using the system's package manager.
The `install-package` tool is used to manage Ubuntu packages you may need for your jobs. It downloads and caches packages in a way that can be quickly reinstalled over and over again in different jobs. This is a tool made for convenience, but you can still use `sudo` to install packages using the system's package manager.


The syntax is:

```shell title="install-package syntax"
install-package <command> <pkg-name>
install-package <flag> <pkg-name>
```

Where `<pkg-name>` is the Ubuntu package name without the `.deb` extension. In other words, you want `libc6` instead of `libc6.deb`.

Where command is one of the following:

- `update`: Retrieve new lists of packages
- `upgrade`: Perform an upgrade
- `install`: Install new packages
- `reinstall`: Reinstall packages
- `remove`: Remove packages
- `purge`: Remove packages and config files
- `autoremove`: Remove automatically all unused packages
- `dist-upgrade`: Distribution upgrade, see apt-get(8)
- `dselect-upgrade`: Follow dselect selections
- `build-dep`: Configure build-dependencies for source packages
- `satisfy`: Satisfy dependency strings
- `clean`: Erase downloaded archive files
- `autoclean`: Erase old downloaded archive files
- `check`: Verify that there are no broken dependencies
- `source`: Download source archives
- `download`: Download the binary package into the current directory
- `changelog`: Download and display the changelog for the given package
Where the flag is one of the following:

- `--update` (or -u): Retrieve new lists of packages
- `--skip-update` (or -s): Skips repository list update
- `--update-new` (or -n): Update only repository lists modified in the last 1 hour

You can supply multiple packages with their versions in the same invocation:

Expand Down