Skip to content

odoo-work-cli tasks

NAME

odoo-work-cli-tasks - List Odoo tasks

SYNOPSIS

odoo-work-cli tasks [--search TEXT] [--json | --format FORMAT] [PROJECT-ID]

DESCRIPTION

List the Odoo tasks visible to you: those of the project PROJECT-ID, or of all projects without it. The [models.task] filters of the configuration restrict the list.

--search TEXT keeps the tasks whose name contains TEXT, ignoring case. The ID column is what entries add --task-id takes. A PROJECT-ID that is not an integer is a validation error.

OPTIONS

--search TEXT

Only tasks whose name contains TEXT (case-insensitive).

string; optional

GLOBAL OPTIONS

--format FORMAT

Output FORMAT: table, json or jsonl.

one of table, json, jsonl; optional; default: table

--json

Shorthand for --format json.

flag; optional

--backend BACKEND

BACKEND: odoo or fake (offline, made-up data; env ODOO_WORK_CLI_BACKEND).

string; optional; default: odoo; env: ODOO_WORK_CLI_BACKEND

--config FILE

Read only the config FILE (skip discovery).

string; optional

-h, --help
Print the help of the command and exit.

OUTPUT

The table has the columns ID, Name, Project and Stage. With --search and no match the command prints "No tasks match TEXT" and exits with 0.

With --json the output is an array of tasks, [] if there are none.

Fields of task.schema.json:

id
integer
name
string
project_id
integer or null
project
string or null
company
string or null
stage
string or null
active
boolean

ENVIRONMENT

ODOO_URL
Odoo server URL; overrides url from the config files.
ODOO_DATABASE
Odoo database name; overrides database.
ODOO_USERNAME
Odoo login, usually an e-mail address; overrides username.
ODOO_PASSWORD
Odoo API key, used for XML-RPC. Despite the name, not the login password.
ODOO_WEB_PASSWORD
Odoo login password, used for the web session of clock in and clock out.
ODOO_TOTP_SECRET
TOTP secret (base32 or otpauth:// URL) for accounts with two-factor authentication.
ODOO_OP_TIMEOUT
Timeout of the 1Password call that resolves [op_secrets], a Go duration; default 5s.
ODOO_WORK_CLI_NO_OP
If 1, true, yes or on, [op_secrets] is ignored and the 1Password CLI is never called.
ODOO_WORK_CLI_BACKEND
Backend, odoo (default) or fake; --backend overrides it.
ODOO_WORK_CLI_FAKE_STATE
State file of the fake backend; default odoo-work-cli-fake-state.json in the temporary directory.
XDG_CONFIG_HOME
Base directory of the global config file; default ~/.config.

FILES

~/.config/odoo-work-cli/config.toml
Global configuration ($XDG_CONFIG_HOME/odoo-work-cli/config.toml if XDG_CONFIG_HOME is set). Created by odoo-work-cli config install.
.odoo-work-cli.toml
Configuration of a directory tree. Every such file from the filesystem root down to the current directory is merged over the global file, the deepest last. --config FILE loads only FILE instead.
$TMPDIR/odoo-work-cli-fake-state.json
State of the fake backend (--backend fake); ODOO_WORK_CLI_FAKE_STATE sets another path. Delete it to start over with the seed data.

EXIT STATUS

0 on success, 1 on any error, including usage errors. With --json or --format json|jsonl the error is printed on standard output as one JSON object, {"error": {"kind": KIND, "message": TEXT}}, and nothing on standard error; otherwise as "Error: TEXT" on standard error, after usage errors followed by the usage.

Error kinds this command can fail with:

auth
Authentication failed: wrong API key or login password, TOTP rejected.
validation
Invalid input: unknown flag, bad argument, malformed date, time or hours, a time in the future, an unknown project.
network
Odoo cannot be reached: DNS, connection refused, timeout, TLS.
config
The local configuration is missing or invalid.
secrets_locked
1Password is locked or unreachable, so op:// references could not be resolved.
internal
Anything else: an unexpected Odoo response or a bug.

EXAMPLES

The tasks of project 1:

$ odoo-work-cli tasks 1
ID       Name                                     Project                        Stage
-------- ---------------------------------------- ------------------------------ --------------------
11       Backend API                              Lighthouse Portal              In Progress
12       Frontend                                 Lighthouse Portal              In Progress
13       Code review                              Lighthouse Portal              In Progress

Tasks named like "review" in any project, as JSON:

$ odoo-work-cli tasks --search review --json
[
  {
    "id": 13,
    "name": "Code review",
    "project_id": 1,
    "project": "Lighthouse Portal",
    "company": "Example Consulting",
    "stage": "In Progress",
    "active": true
  }
]

SEE ALSO