How do I run the accounts commands from the shell?

Table of Contents

This file documents the accounts resource at the shell, one section per command. Every command is a subcommand of accounts, and every section exports its own script into projects/ores.shell/scripts/library/. Loading a script runs that one command, so a failure names the command it came from.

1. Commands

1.1. list

Reads one page of the collection. Nothing addresses it but the caller's tenant, so it is the read that shows what exists.

The command is shaped like this:

accounts list [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at iam.v1.accounts.list.

accounts list --limit 1

1.2. get

Reads the one row its key addresses. A key states every identifying column, so a partial key is refused rather than answered with an arbitrary row.

The command is shaped like this:

accounts get <username>

It is addressed at iam.v1.accounts.get.

accounts get __none__

1.3. get-many

Reads several rows in one request, one key group per row.

The command is shaped like this:

accounts get-many <username>

It is addressed at iam.v1.accounts.get_many.

accounts get-many __none__

1.4. versions

Reads the row's recorded history, newest first.

The command is shaped like this:

accounts versions <username> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at iam.v1.accounts_versions.list.

accounts versions __none__ --limit 1

1.5. version

Reads one recorded version of the row.

The command is shaped like this:

accounts version <username> --version <n>

It is addressed at iam.v1.accounts_versions.get.

accounts version __none__ --version 1

Emacs 29.3 (Org mode 9.6.15)