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.5.0. Stages 1–5 of the v1 seating system are in: floor SVG parser/validator, CSV / Google Sheets-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, and a search-first web map. Effective dates, SSO/roles, and DynamoDB land in later stages. 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

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):

pip install office-cli[bamboohr]
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.

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.

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.5.0.tar.gz (151.9 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.5.0-py3-none-any.whl (69.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: office_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 151.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.5.0.tar.gz
Algorithm Hash digest
SHA256 02b3e4375f7f4bd09757579972e58949a83eb1804ba8a8ff5e0bf081faf1e573
MD5 93c56a60e9b974a6072f22617b0d0e98
BLAKE2b-256 8f52405b89aa9457d796fecc626cc762b5628dce5a3d0eb1d43cd5f7c320599e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: office_cli-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 69.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcd1baee0fb2110aaff99ad1812e9961c55f0ddde6d58fc5181fcabedbe9a26b
MD5 1c9a538e5dd6bc94ca5567c06752eb45
BLAKE2b-256 bcf616972a26ec233b989e649453511307d8b95ba0fd78dc4f55d3ad7d61367e

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