Skip to content

odoo-work-cli projects

NAME

odoo-work-cli-projects - List Odoo projects

SYNOPSIS

odoo-work-cli projects [--search TEXT] [--json | --format FORMAT]

DESCRIPTION

List the Odoo projects visible to you. The [models.project] filters of the configuration restrict the list; its extra_fields add columns (and the extra_fields object of the JSON output).

--search TEXT keeps the projects whose name or customer contains TEXT, ignoring case. The ID column is what entries add --project-id and the argument of tasks take.

OPTIONS

--search TEXT

Only projects whose name or customer 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, Customer, Company, Phase (the project stage), Project Manager, one column per extra field of [models.project], and Active. With --search and no match the command prints "No projects match TEXT" and exits with 0.

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

Fields of project.schema.json:

id
integer
name
string
active
boolean
customer
string or null
company
string or null
stage
string or null
project_manager
string or null
extra_fields
object

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

All projects:

$ odoo-work-cli projects
ID     Name                           Customer             Company         Phase           Project Manager      Active
------ ------------------------------ -------------------- --------------- --------------- -------------------- ------
1      Lighthouse Portal              Example Harbor Ltd   Example Consulting In Progress     Alex Demo            true
2      Orchard Mobile App             Example Orchard Inc  Example Consulting In Progress     Alex Demo            true
3      Internal                                            Example Consulting In Progress     Alex Demo            true
4      Riverbank Data Migration       Example River Co     Wildflower Labs In Progress     Alex Demo            true

Projects whose name or customer contains "portal", as JSON:

$ odoo-work-cli projects --search portal --json
[
  {
    "id": 1,
    "name": "Lighthouse Portal",
    "active": true,
    "customer": "Example Harbor Ltd",
    "company": "Example Consulting",
    "stage": "In Progress",
    "project_manager": "Alex Demo",
    "extra_fields": {}
  }
]

SEE ALSO