🚩 Commands and options

The general syntax of the qob program is:

$ qob [GLOBAL-OPTIONS] [COMMAND] [COMMAND-OPTIONS] [COMMAND-ARGUMENTS]

Create a new Common Lisp project

$ qob [GLOBAL-OPTIONS] create cl-project <name>

💡 See https://github.com/fukamachi/cl-project for more information.

Often use commands that are uncategorized.

Initialize the current directory to start using Qob.

$ qob [GLOBAL-OPTIONS] init

Qob will generate the file like this:

;; -*- mode: lisp; lexical-binding: t -*-

(source "quicklisp")

Show information about the project or configuration.

$ qob [GLOBAL-OPTIONS] info

Display the state of the workspace.

$ qob [GLOBAL-OPTIONS] status

To install all dependencies.

$ qob [GLOBAL-OPTIONS] install-deps

To install systems.

$ qob [GLOBAL-OPTIONS] install [SYSTEMS..]

Install systems by specifying arguments:

$ qob install clingon clack

Or else, it will install the system from the current development:

$ qob install

To uninstall/delete systems.

$ qob [GLOBAL-OPTIONS] uninstall [SYSTEMS..]

Uninstall systems by specifying arguments:

$ qob uninstall cl-autorepo cl-project

Or else, it will uninstall the system from the current development:

$ qob uninstall

Build the system artifact.

$ qob package [DESTINATION]

If [DESTINATION] is not specified, it will generate to the /dist folder by default.

Print all system files.

$ qob files [DESTINATION]

Commands allow you to execute on top of the Qob core.

Basically, this allows you to do anything you want!

Load Common Lisp files in order.

$ qob [GLOBAL-OPTIONS] load [FILES..]

Execute the system command with the given arguments.

$ qob [GLOBAL-OPTIONS] exec [COMMAND] [ARGUMENTS ...]

Evaluate FORM as a lisp form.

$ qob [GLOBAL-OPTIONS] eval [FORM]

Commands that help you manage your package’s dependencies.

List out all installed dists.

$ qob [GLOBAL-OPTIONS] dists

Search systems from archives.

$ qob [GLOBAL-OPTIONS] search [QUEIRES..]

List systems.

$ qob [GLOBAL-OPTIONS] list [--depth]

Link between this system and a dependency on the local filesystem. A linked dependency avoids the need to download a dependency from a remote archive. The system linked to must either have a Qob-file or a ASD-file.

Links the given source directory into the system directory of this project, under the given system name.

$ qob [GLOBAL-OPTIONS] link add <NAME> <PATH>

Deletes the link for the given systems.

$ qob [GLOBAL-OPTIONS] link delete [NAMES..]

List all links.

$ qob [GLOBAL-OPTIONS] link list

Delete various files produced during building.

Delete .qob from the current workspace.

Alias: .qob

$ qob [GLOBAL-OPTIONS] clean workspace

Delete dist subdirectory.

$ qob [GLOBAL-OPTIONS] clean dist

This command is the combination of all other clean commands.

• clean workspace
• clean dist

$ qob [GLOBAL-OPTIONS] clean all

Other helper commands.

Show Qob installed location.

$ qob [GLOBAL-OPTIONS] locate

The following options are available on all Qob commands:

This will use ~/.qob/ instead of the package development environment.

This is used for other tasks. e.g., cat, etc.

$ qob -g [COMMAND]

Enable the all flag.

$ qob -a [COMMAND]

Force command’s execution.

Force to uninstall the package dash even it’s a dependency from another packages.

$ qob -f [COMMAND]

Continue the execution without killing the program.

Enable/Disable timestamps.

Enable/Disable log header.

Weather to generate log files.

Disable color output.

Show elapsed time between each operation.

Set verbosity from 0 to 5.

$ qob --verbose 4 [COMMAND]

Show version number.

Show help.