Skip to content

odoo-work-cli clock

NAME

odoo-work-cli-clock - Clock in/out and attendance status

SYNOPSIS

odoo-work-cli clock COMMAND [OPTIONS]

DESCRIPTION

Record attendance: clock in and out now or at an earlier time, show today's status, list the records of a day or week, and correct or add records afterwards.

A record belongs to the day of its check-in. Clock in and clock out without --at go through the Odoo attendance systray of the web session, which every employee may use; it needs the login password and, with two-factor authentication, the TOTP secret. --at, edit and add write hr.attendance over XML-RPC, which requires the Attendance Officer access right.

Subcommands:

odoo-work-cli clock add
Add an attendance record (e.g. the second half of a day with a break).
odoo-work-cli clock edit
Edit an attendance record's check-in/check-out time.
odoo-work-cli clock in
Clock in (start attendance).
odoo-work-cli clock list
List attendance records of a day or week.
odoo-work-cli clock out
Clock out (end attendance).
odoo-work-cli clock status
Show current attendance status.

OPTIONS

None besides the global options.

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.

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

What is recorded for a day:

$ odoo-work-cli clock list --date 2026-04-08
ID      Check In         Check Out        Duration
------- ---------------- ---------------- --------
4606    2026-04-08 08:30 12:00            3:30
4607    2026-04-08 12:30 17:00            4:30

Total: 8:00

SEE ALSO