Documentation
The command line
This page as Markdown, or in an AI chatMore ways to read this page
The same figures as the dashboard, in a terminal: for scripts, and for people who live there.
# The command line > tidekeeper's documentation: https://tidekeeper.eu/docs/cli The same figures as the dashboard, in a terminal: for scripts, and for people who live there. ## Getting it For Linux and macOS, in one line: it fetches the build for your machine, checks it against its sum, and puts it in `~/.local/bin`: ```sh curl -fsSL https://tidekeeper.eu/install.sh | sh ``` Or by hand: [Linux on x86-64](https://tidekeeper.eu/download/tidekeeper-linux-x86_64), [Linux on ARM](https://tidekeeper.eu/download/tidekeeper-linux-aarch64), [macOS on Intel](https://tidekeeper.eu/download/tidekeeper-macos-x86_64), [macOS on Apple silicon](https://tidekeeper.eu/download/tidekeeper-macos-aarch64), and [their sums](https://tidekeeper.eu/download/SHA256SUMS). ## Signing in Through the browser: it opens a page here where you let the command line in. ```sh tidekeeper login --server https://tidekeeper.eu ``` The token it gets only reads; it is kept in `~/.config/tidekeeper/token`, and listed under Settings, API tokens, where you can take it back. Over SSH, `--no-browser` prints the page to open instead. Or give it a token of your own, in `~/.config/tidekeeper/config.toml` or in the environment: ```sh export TIDEKEEPER_SERVER=https://tidekeeper.eu export TIDEKEEPER_TOKEN_FILE=~/.config/tidekeeper/token ``` ## What it does ```sh tidekeeper login --server https://tidekeeper.eu # once: sign in through the browser tidekeeper status # every site at a glance; exits 1 when one needs attention tidekeeper top sources your-site.example --last 7d tidekeeper stats your-site.example --metrics visitors,views --by day --json tidekeeper why your-site.example views --page /install tidekeeper changed your-site.example tidekeeper tail your-site.example # a line a minute, by page, never by reader tidekeeper check https://your-site.example/ tidekeeper mcp # the MCP server, for an AI agent ``` Every command takes `--json` for a script, and `--help` says the rest.
Getting it
For Linux and macOS, in one line: it fetches the build for your machine, checks it against its sum, and puts it in ~/.local/bin:
curl -fsSL https://tidekeeper.eu/install.sh | sh
Or by hand: Linux on x86-64, Linux on ARM, macOS on Intel, macOS on Apple silicon, and their sums.
Signing in
Through the browser: it opens a page here where you let the command line in.
tidekeeper login --server https://tidekeeper.eu
The token it gets only reads; it is kept in ~/.config/tidekeeper/token, and listed under Settings, API tokens, where you can take it back. Over SSH, --no-browser prints the page to open instead. Or give it a token of your own, in ~/.config/tidekeeper/config.toml or in the environment:
export TIDEKEEPER_SERVER=https://tidekeeper.eu export TIDEKEEPER_TOKEN_FILE=~/.config/tidekeeper/token
What it does
tidekeeper login --server https://tidekeeper.eu # once: sign in through the browser tidekeeper status # every site at a glance; exits 1 when one needs attention tidekeeper top sources your-site.example --last 7d tidekeeper stats your-site.example --metrics visitors,views --by day --json tidekeeper why your-site.example views --page /install tidekeeper changed your-site.example tidekeeper tail your-site.example # a line a minute, by page, never by reader tidekeeper check https://your-site.example/ tidekeeper mcp # the MCP server, for an AI agent
Every command takes --json for a script, and --help says the rest.