5 Command-line interface🔗ℹ

5.1 Synopsis🔗ℹ

Req invocation in any one of the following forms is accepted:

• raco req [action-flag] [option-flag] ...

• raco req <info-flag>

5.2 Action flags🔗ℹ

Only up to one action-flag can be given at a time.

The action-flag is any one of the following:

• -s or --show — show Req setting of the current project.

  This is the default action that is executed if Req is run only as raco req.

  The resulting output of this action will be similar to the following:

  catalogs:

  - https://pkgs.racket-lang.org/

  local:

  - req-test ✓

  /home/user/source/public/gitlab.com/xgqt/racket-req/src/req-test

  - req-lib ✓

  /home/user/source/public/gitlab.com/xgqt/racket-req/src/req-lib

  - req ✓

  /home/user/source/public/gitlab.com/xgqt/racket-req/src/req

  - req-doc ✓

  /home/user/source/public/gitlab.com/xgqt/racket-req/src/req-doc

  dependencies:

  - base ✓

  - racket-doc ✓

  - rackunit-lib ✓

  - scribble-lib ✓

  - threading-lib ✓

  - upi-lib ✓

  - ziptie-git ✓

  extras:

  - dev:

  - ziptie-monorepo ✓

• -d or --deps — install external dependencies of project’s local packages.

  Dependencies are gathered from all info files of included local packages.

• -l ‹local-package-name› or --local ‹local-package-name› — install a local package.

• -L or --locals — install all local packages.

• -a or --all — install "deps" and "locals",

  in other words this flag acts as though running --deps followed by --locals.

• -e ‹extra-set-name› or --extra ‹extra-set-name› — install an extra set of the name ‹extra-set-name›.

  For example: if a set "dev" is defined as containing "pkgA" and "pkgB", then executing raco req -e dev will install both of those packages.

• -E or --extras — install all extra sets.

  For example: if a set "A" is defined as containing "pkgA" and a set "B" is defined as containing "pkgB", then executing raco req -E will install both packages from sets "A" and "B".

• -A or --everything — install "all" and "extras", in other words this flag acts as though running --all followed by --extras.

• -R or --remove — remove all local packages. If you wish to remove and then install again the local packages, then use the --reinstall flag instead.

5.3 Option flags🔗ℹ

Any different option-flags can be given at a time, multiples of the same option-flag are not accepted.

The option-flag is any one of the following:

• -r or --reinstall — when the installation of local packages is requested, if a local package is already installed, then it is first removed and installed afterwards.

  For more info see req-reinstall-local?.

• -p ‹dir-path› or --project ‹dir-path› — path to the project directory.

• -f ‹file-path› or --file ‹file-path› — path to the project’s Req file in a supported format.

  The format parser to be used is chosen based on the file extension.

• -n or --no-local-chain — do not install other local packages if a singular local is wanted.

  For more info see req-local-chain?.

• -c or --no-colors — disable colors.

• -q or --quiet — be quiet (minimal/no console output).

• -v or --verbose — be verbose (detailed console output).

5.4 Information flags🔗ℹ

If Req is invoked with a info-flag only that and no other action-flag, option-flag nor info-flag can be given.

The info-flag is any one of the following:

• -h or --help — show the help page.

• -V or --version — show the version of this program and exit.