@opsrev/companycam-cli
v1.1.0
Published
CLI for the CompanyCam REST API
Maintainers
Readme
@opsrev/companycam-cli
A minimal CLI for the CompanyCam REST API. Designed for AI agents — JSON output, no interactive prompts, predictable flags.
Install
npm install -g @opsrev/companycam-cliConfigure
Generate a Personal Access Token in the CompanyCam developer dashboard, then either:
- Set the env var:
export COMPANYCAM_API_KEY=<token> - Or pass on every call:
--api-key <token>
Commands
projects list
Search/list projects, sorted by most recent activity.
companycam projects list
companycam projects list --query "123 Main St"
companycam projects list --modified-since 2026-01-01T00:00:00Z
companycam projects list --limit 100Flags:
--query <text>— filter by project name or address line 1--modified-since <iso8601>— only projects modified at or after this timestamp--limit <n>— max total results (default: 25)
projects get <projectId>
Fetch a single project by ID.
companycam projects get 123456projects photos <projectId>
List photos for a project.
companycam projects photos 123456
companycam projects photos 123456 --limit 200
companycam projects photos 123456 --allFlags:
--limit <n>— max total photos (default: 25)--all— fetch every photo for the project
Output
All successful output is a single line of JSON to stdout. Errors go to stderr as {"error":"<message>"} and the process exits with code 1.
companycam projects list --query Smith | jq '.[].id'Development
git clone https://github.com/opsrev/companycam-cli.git
cd companycam-cli
npm install
cp .env.example .env # add your COMPANYCAM_API_KEY
npm run dev -- projects list --limit 5
npm testLicense
MIT
