CLI reference¶

tiroir is administered with one command, tiroir, that ships inside the server's image. In version 0.1.0 it holds the administration CLI, tiroir admin, which you run in the server's container from the directory of the stack:

docker compose exec tiroir tiroir admin <command> [options]

It works directly on the server's data, so it needs no token: shell access to the container is the administrator's credential. A change to members or access takes effect at the members' next request.

Every command accepts -h or --help, which prints its usage. The examples below leave out the docker compose exec tiroir prefix.

tiroir¶

usage: tiroir [-h] [--version] {admin} ...

tiroir admin init¶

usage: tiroir admin init [-h]

Creates the first administrator, handle admin, and prints its initial password once. The administrator chooses a new password at the first sign-in. The command refuses to run on a server that already has an administrator. On a new server, it first prints the steps that set up the server's database.

$ tiroir admin init
server database migrated to version 1
…
member created: …
administrator: admin
initial password (shown once, to change at first sign-in): …

tiroir admin members¶

usage: tiroir admin members [-h] {list,add,disable,reset-password} ...

Lists and changes the server's members. Without an action, it lists them.

members list¶

usage: tiroir admin members list [-h]

Prints one member per line: handle, display name, and [admin] or [disabled] when they apply.

$ tiroir admin members list
admin   Administrator  [admin]
alice   Alice

members add¶

usage: tiroir admin members add [-h] --name NAME [--admin] handle

Creates the member and prints an initial password once, to change at the first sign-in.

$ tiroir admin members add alice --name Alice
member created: …
member: alice
initial password (shown once, to change at first sign-in): …

members disable¶

usage: tiroir admin members disable [-h] handle

Disables the member and removes their access to every store: they can no longer sign in. The handle stays reserved.

$ tiroir admin members disable alice
member disabled: …
alice: disabled

members reset-password¶

usage: tiroir admin members reset-password [-h] handle

Gives the member a new password, printed once, to change at their next sign-in.

$ tiroir admin members reset-password alice
member password reset: …
alice: new password (shown once, to change at next sign-in)
…

tiroir admin stores¶

usage: tiroir admin stores [-h] {list,add} ...

Lists and creates stores. Without an action, it lists them.

stores list¶

usage: tiroir admin stores list [-h]

Prints one store per line: name, audience, language, and the number of members with access to it.

$ tiroir admin stores list
alice-memory    personal    fr  1 members
team-memory team    en  1 members

stores add¶

usage: tiroir admin stores add [-h] --audience {personal,team}
                               --language LANGUAGE [--owner OWNER]
                               [--preset PRESET]
                               name

Creates the store and indexes it.

$ tiroir admin stores add alice-memory --audience personal --language fr \
    --owner alice --preset accounting-firm
store: alice-memory

tiroir admin grant¶

usage: tiroir admin grant [-h] handle store {read,write}

A personal store has its owner only: granting it to another member is refused.

$ tiroir admin grant bob team-memory read
bob: read access to team-memory

tiroir admin revoke¶

usage: tiroir admin revoke [-h] handle store

Removes the member's access to the store. Revoking an access the member does not have is not an error.

$ tiroir admin revoke bob team-memory
bob: no access to team-memory

tiroir admin index¶

usage: tiroir admin index [-h] [--store STORE] [--rebuild]

Indexes are brought up to date when a store is created and after each write, so this is rarely needed. It prints, per store, the files it indexed (none when the index was already up to date) and the chunks the index holds.

$ tiroir admin index --store alice-memory
alice-memory: 0 files indexed, 399 chunks
$ tiroir admin index --rebuild
alice-memory: 247 files indexed, 399 chunks
team-memory: 247 files indexed, 399 chunks

tiroir admin serve¶

usage: tiroir admin serve [-h]

Runs the server on port 8080. It is the image's entry point, which Compose starts for you; you do not run it by hand.

Exit codes¶