Reference

Command line

$ qoqi <command> [arguments]

qoqi with no command prints the help; qoqi serve --help prints the usage of every command of flows.

Flows

qoqi serve is the daemon: it starts, and is given its programs by qoqi deploy. Every other command but gen talks to it over its HTTP API, from its machine or from elsewhere:

• on its machine, by the files it keeps in its home, QOQI_PATH;
• from anywhere, with --url and --token, or QOQI_URL and QOQI_TOKEN.

$ export QOQI_URL=https://flows.example.com QOQI_TOKEN=$(ssh flows cat .qoqi/token)
$ qoqi deploy shop.qi
$ qoqi ls --status stopped

The home: QOQI_PATH

The folder where the daemon keeps all of its files, ~/.qoqi when QOQI_PATH is not set:

One daemon runs from a home at a time: a second is refused while the first lives.

qoqi serve

$ qoqi serve [--listen 127.0.0.1:7070] [--hosts name,...] [--store address] [--workers N]

Runs the daemon, with the flows deployed to its store, until it is stopped (Ctrl-C, SIGTERM). It takes no program: qoqi deploy gives it them, and it serves them again each time it starts.

The first time, the console has one user: admin, password admin, which is changed at the first sign in.

qoqi deploy

$ qoqi deploy <program or folder> [--dry] [--watch]

A new version to the daemon, served at once: what runs ends its turn, and each instance moves at its next stage. The program is compiled here, and sent. --dry says what it would do; --watch deploys again each time a file is saved, and says what does not compile or is refused while the version before goes on. Writes flow.lock next to the program.

qoqi undeploy

$ qoqi undeploy <program>

Takes a program away, once none of its instances is alive. Its versions and instances are kept.

qoqi versions, qoqi diff

$ qoqi versions [program]
$ qoqi diff <seq or program> [--from seq]

The deploys kept, the last first, and what runs on each; what a deploy changed of the source, from the one before (or --from).

qoqi start

$ qoqi start <Flow> <name> [fields as JSON]

Starts an instance. A name taken gives the instance that has it. Prints the instance as JSON.

qoqi ls, qoqi show, qoqi result

$ qoqi ls [--flow Flow] [--status waiting|running|stopped|done|failed] [--json]
$ qoqi show <name> [--json]
$ qoqi result <name> [--wait 30s] [--json]

The instances and what each is doing; one instance, where it is, what it was given, what its steps returned; what its run returned, waiting for it that long. result ends with status 2 if the instance has not ended.

qoqi send

$ qoqi send <name> <inbox> <message as JSON> [--key evt-1]

A message for an inbox of an instance. A key sent before is one message.

qoqi cancel, qoqi resume, qoqi answer, qoqi end

$ qoqi cancel <name> [reason]
$ qoqi resume <name> [--go]
$ qoqi answer <name> <key> (<what it did, as JSON> | --nothing)
$ qoqi end <name> [reason]

Cancels an instance, its undos run; takes a stopped instance up, showing what it would do, --go to do it; answers for a step the application could not tell of; ends a stopped instance as it is. See failures.

qoqi ui

Opens the console of the daemon in a browser. People sign in to it with a name and a password; see qoqi users.

qoqi users

$ qoqi users add ada                  # the password is asked for, twice
$ echo "$PASSWORD" | qoqi users add ci --password-stdin
$ qoqi users ls
$ qoqi users passwd ada               # their sessions end; they choose another at their next sign in
$ qoqi users rm ada

The people who sign in to the console, through the daemon. The console starts with admin, password admin; a password given to someone, here or in the console, is theirs to change at their next sign in, before anything else.

qoqi gen

$ qoqi gen go <program> [--package steps] [--queue billing]
$ qoqi gen php <program> --namespace 'App\Flow' --out src/Flow [--queue billing]
$ qoqi gen ts <program> [--from @qoqi/flow] [--queue billing]

Writes what an application needs to carry out the steps of its queues: their types, an interface for each queue, and the handler that serves it. Go and TypeScript are written to the standard output; PHP to a file per class. See steps in your application.

Programs

Options for the commands that run a program, anywhere after the command:

After a lone --, everything is the program's.

Exit status

0 on success, or the Int main returned; 1 for a compile error, a runtime error, a usage error or a refusal of the daemon; 2 for qoqi result on an instance that has not ended.