Skip to main content

Office — CLI to manage sittings and meeting rooms in office maps.

Project description

office

Agent-first CLI for managing seat assignments and meeting rooms across office floor plans. Floor layouts are hand-traced SVGs; people come from BambooHR; assignments live in a Google Sheet (v1) or DynamoDB (v2). The CLI exposes the same operations as the Slack /whereis command and the web map.

Status — v0.8.0. Stages 1–8 of the v1 seating system are in: floor SVG parser/validator, CSV / Google Sheets / DynamoDB-backed assignment store with append-only audit log, BambooHR-backed EmployeeDirectory with the auto-vacate killer feature, CLI verbs (floors, seats, whereis), a Slack /whereis slash-command listener, a search-first web map, effective-date enforcement, SSO + role-aware redaction, and bi-directional Sheets ↔ Dynamo sync. See issue #1.

Naming surfaces

office uses three different identifiers across packaging surfaces. Mind the split — do not blanket-replace one token across the codebase.

Surface Value
GitHub repo agentculture/office-agent
PyPI distribution office-cli
Python package office_cli
CLI binary office
Error class prefix Office

Install

uv tool install office-cli
office --version

For the full setup walkthrough — including how to opt into each optional backend (Sheets, DynamoDB, BambooHR, Slack, web map, SSO) — see docs/setup.md.

Use

office learn                                    # self-teaching prompt
office explain seats                            # markdown docs for any verb
office whoami --json                            # auth probe (stub)

# v0.1.0 seating verbs:
office floors list --json
office floors validate floors/tlv-floor-5.svg
office seats list --vacant
office seats assign 5-T-01 alice@example.com
office seats move alice@example.com 5-T-02
office seats history 5-T-01 --json
office whereis alice@example.com

office reads data/offices.yaml, floors/, and seats/ from the current working directory. Override with --data-dir DIR or OFFICE_DATA_DIR=DIR.

Storage backend

office defaults to CSV-backed storage under seats/ (assignments.csv, audit-log.csv). To use Google Sheets instead:

pip install office-cli[sheets]
export OFFICE_STORE=sheets
export OFFICE_SHEETS_ID=1abc...
export OFFICE_SHEETS_SA=/path/to/service-account.json

…or declare it in data/offices.yaml:

storage:
  type: sheets
  sheets:
    spreadsheet_id: "1abc..."
    service_account: "data/sheets-service-account.json"
    cache_ttl_seconds: 300

Reads honor a 5-minute TTL cache; writes invalidate it. See docs/architecture.md for the full storage contract.

People directory (BambooHR)

office defaults to a no-op StubDirectory that trusts whatever email it receives. Switch to BambooHR for the auto-vacate killer feature (seats render as vacant automatically when an employee is offboarded).

Note: the BambooHR backend is gated off by default. Set OFFICE_BAMBOOHR_ENABLED=1 in addition to the config below; without it, even valid BambooHR settings silently fall back to the stub directory (with a one-line warning to stderr).

pip install office-cli[bamboohr]
export OFFICE_BAMBOOHR_ENABLED=1   # required: opt in to the gated feature
export OFFICE_DIRECTORY=bamboohr
export BAMBOOHR_SUBDOMAIN=tipalti
export BAMBOOHR_API_TOKEN=...   # env-only — do not commit

…or declare the public bits in data/offices.yaml and keep the token in the env:

directory:
  type: bamboohr
  bamboohr:
    subdomain: tipalti
    cache_ttl_seconds: 300

The directory affects rendering only; assignments stay in the store unchanged. Re-activating an employee in BambooHR restores their seat without any write.

Slack /whereis

Run a Slack /whereis slash command backed by the same SeatService:

pip install office-cli[slack]
export SLACK_BOT_TOKEN=xoxb-...
export SLACK_APP_TOKEN=xapp-...
office slack-serve

Required Slack app scopes:

  • commands — to register /whereis.
  • users:read.email — for users.info to return profile.email.
  • chat:write — to post the ephemeral response.

Three invocation shapes:

  • /whereis — looks up the caller's own seat.
  • /whereis @user — Slack mention; resolves the user's email.
  • /whereis email@domain — plain text fallback.

A trailing YYYY-MM-DD token on any of the three shapes filters by effective date — e.g. /whereis alice@x 2026-07-01 returns Alice's seat as of that date.

Responses are ephemeral by default — only the caller sees them. hidden=TRUE seats render as "occupied (private)" until role gating (Stage 7) lifts the filter for privileged callers. Setting OFFICE_WEB_BASE_URL to your office serve deployment adds an "Open map" deep-link button to the response.

Effective-date windows

Assignments can carry an effective window so the seat map renders "as of" any date:

office seats assign 5-T-01 alice@example.com --from 2026-07-01 --until 2026-12-31
office whereis alice@example.com                     # default = today
office whereis alice@example.com --as-of 2026-07-15  # inside the window
office seats list --as-of 2026-09-01

The web map honors ?asOf=YYYY-MM-DD in the URL — http://localhost:8000/offices/tlv/floors/tlv-floor-5?asOf=2026-07-15 shows the same view, deep-linkable.

effective_from / effective_until are stored as YYYY-MM-DD (date precision); last_updated and audit-log timestamps stay full ISO-8601. Empty bounds mean "always begins" / "no end".

DynamoDB backend + Sheets sync

office ships three storage backends behind a single Protocol: CSV (default), Google Sheets, and DynamoDB. They are interchangeable runtime backends; pick one via OFFICE_STORE or storage.type in data/offices.yaml.

pip install office-cli[dynamo]
export OFFICE_STORE=dynamo
export OFFICE_DYNAMO_ASSIGNMENTS=office-assignments
export OFFICE_DYNAMO_AUDIT=office-audit-log
export OFFICE_DYNAMO_REGION=us-east-1
# AWS creds via AWS_PROFILE / IAM role / standard chain
office seats list

YAML:

storage:
  type: dynamo
  dynamo:
    table_assignments: office-assignments
    table_audit: office-audit-log
    region: us-east-1
    cache_ttl_seconds: 300

The office-assignments table is keyed on seat_id. The office-audit-log table is keyed on seat_id (PK) + timestamp (SK) so re-running migrations doesn't duplicate audit rows.

One-shot import/export

# Bootstrap Dynamo from Sheets:
office seats migrate --from sheets --to dynamo --dry-run   # preview
office seats migrate --from sheets --to dynamo

# Snapshot Dynamo back to Sheets for offline review:
office seats migrate --from dynamo --to sheets --audit-append

Bi-directional sync (Sheets ↔ Dynamo)

Sheets stays the human-friendly editor; Dynamo is the runtime read path. Run office seats sync periodically (cron / GitHub Action) to reconcile both sides via last-write-wins on last_updated:

# Pick the tie-breaker side when last_updated matches but content
# diverges (rare). The reconcile is idempotent — re-running converges.
office seats sync --primary sheets --dry-run
office seats sync --primary sheets

The CLI is the supported sync entry point; there is no always-on daemon (a Stage-9+ addition if needed).

SSO + roles

The web frontend can be gated behind your IdP via OIDC. Three roles are recognized: viewer (default — sees hidden=TRUE seats as "occupied (private)"), editor (HR/IT — full details on hidden seats), and planning (facilities — same as editor in v1).

pip install office-cli[sso,web]
export OIDC_ISSUER=https://your-idp.example.com
export OIDC_CLIENT_ID=office-agent
export OIDC_CLIENT_SECRET=xxx
export OIDC_REDIRECT_URL=https://office.example.com/auth/callback
export SESSION_SECRET=$(openssl rand -hex 32)
office serve --port 8000

Role mapping lives in data/offices.yaml under a top-level roles: block:

roles:
  editor:
    - "hr-it@tipalti.com"
    - "alice@tipalti.com"
  planning:
    - "facilities@tipalti.com"

Anything not listed is viewer — including unmatched authenticated users.

When the OIDC env vars are unset, office serve runs in auth-disabled mode: no redirects, no session middleware, every request is anonymous. This is the default for local dev. An optional X-Test-Role: editor request header drives role-aware behavior in that mode (useful for curl smoke tests). The header is only honored when OIDC is disabled.

The CLI is operator-only and always unrestricted (no role flag). Slack /whereis resolves the calling user's role from their email via the same roles map.

Adding a new floor

  1. Trace the floor in Inkscape following docs/tracing-guide.md and the SVG ID contract in CLAUDE.md. Save as Plain SVG.
  2. Drop the SVG into floors/ as <office>-floor-<N>.svg.
  3. Add an entry to data/offices.yaml with cluster capacities and any named rooms.
  4. Verify: office floors validate floors/<file>.svg. Errors fail the command; warnings (e.g. cluster-capacity mismatches) are informational.

Develop

uv sync
uv run pytest -n auto -v
uv run office --version
uv run python -m office_cli

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

office_cli-0.9.5.tar.gz (224.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

office_cli-0.9.5-py3-none-any.whl (97.9 kB view details)

Uploaded Python 3

File details

Details for the file office_cli-0.9.5.tar.gz.

File metadata

  • Download URL: office_cli-0.9.5.tar.gz
  • Upload date:
  • Size: 224.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for office_cli-0.9.5.tar.gz
Algorithm Hash digest
SHA256 d3e7d28adbce40c87e4d6f3c87ba0ff228b22f5297d9e289b8d6b62ffd73a4b6
MD5 1cce7fe70386e042ca642a9efe2af8f8
BLAKE2b-256 a38e1f4ae1e113f768c1de15c765b7856157a0533cda86d8e68471011f56955f

See more details on using hashes here.

File details

Details for the file office_cli-0.9.5-py3-none-any.whl.

File metadata

  • Download URL: office_cli-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 97.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for office_cli-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 67d54282fce9ce782a39d21ebd90fa0ae6798377450a4e10e891ac2dccfde00a
MD5 f286d8b41c74c0e0c0a81dde2d34f92c
BLAKE2b-256 57ee81651981e9e6115655ec53134d22dc49e3a41906eb271cd9041ac8c6cd9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page