CLI Usage

Here we document basic CLI usage for some modules and utilities.

Note

This currently only documents those modules which use the click CLI library.

aw-client

CLI utility for aw-client to aid in interacting with the ActivityWatch server

aw-client [OPTIONS] COMMAND [ARGS]...

Options

--host <host>

Address of host

--port <port>

Port to use

-v, --verbose

Verbosity

--testing

Set to use testing ports by default

Commands

buckets

List all buckets

canonical

Query ‘canonical events’ for a single host…

events

Query events from bucket with ID bucket_id

heartbeat

Send a heartbeat to bucket with ID…

query

Run a query in file at path on the server

report

Generate an activity report

Not yet documented

These modules do not yet have their CLI usage documented here. You can learn about their use by running them with --help.

• aw-server

• aw-watcher-afk

• aw-watcher-window