Skip to content

odoo-work-cli clock add

NAME

odoo-work-cli-clock-add - Add an attendance record (e.g. the second half of a day with a break)

SYNOPSIS

odoo-work-cli clock add --in TIME --out TIME [--date YYYY-MM-DD] [--json | --format FORMAT]

DESCRIPTION

Add a new attendance record with check-in --in and check-out --out on the given day (--date, default today).

Unlike 'clock edit', it always creates a new record, also on days that already have records, so a day with a break is two 'clock add' calls. If the new span overlaps an existing record (including a record from the day before that runs past midnight, or a running record) the command aborts with a "conflict" error, names the overlapping record and changes nothing. Adjacent records (12:00 out, 12:00 in) do not overlap.

Times are HH:MM on --date or "YYYY-MM-DD HH:MM". A time more than one minute in the future, or a check-out not after the check-in, is a validation error.

Adding attendance over the API requires the 'Attendance Officer' access right, with you set as your own attendance manager.

OPTIONS

--date YYYY-MM-DD

Day of the new record, YYYY-MM-DD.

string; optional; default: today

--in TIME

Check-in TIME, HH:MM or "YYYY-MM-DD HH:MM".

string; required

--out TIME

Check-out TIME, HH:MM or "YYYY-MM-DD HH:MM".

string; required

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

Prints "Created attendance #ID: FROM - TO".

With --json the created record.

Fields of attendance.schema.json:

id
integer
employee_id
integer or null
employee
string or null
check_in
string (RFC 3339 timestamp)
check_out
string (RFC 3339 timestamp) or null
running
boolean
worked_hours
number
worked_minutes
integer

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.
access_denied
Odoo's access rules forbid the operation, e.g. attendance writes without the Attendance Officer right.
validation
Invalid input: unknown flag, bad argument, malformed date, time or hours, a time in the future, an unknown project.
conflict
The request contradicts the current state, e.g. clock in while clocked in, or an overlapping attendance record.
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 afternoon of a day with a break: a second record:

$ odoo-work-cli clock add --date 2026-04-07 --in 17:00 --out 18:30
Created attendance #5000: 2026-04-07 17:00 - 18:30

An overlapping span is a conflict, and nothing is changed:

$ odoo-work-cli clock add --date 2026-04-08 --in 11:00 --out 13:00
Error: 2026-04-08 11:00 - 13:00 overlaps attendance record #4606; nothing was changed. Overlapping records:
  #4606 2026-04-08 08:30 - 12:00 (3:30)
  #4607 2026-04-08 12:30 - 17:00 (4:30)

SEE ALSO