Command Line

Command Line

where-cli does everything Where does, from a terminal. It's included with Where on Windows (next to Where.exe). On other systems, build it from source: cargo build --release -p where_cli, then find it in target/release/.

It's called where-cli because Windows already has a where command.

Examples

where-cli demo                                    # load an example and search it
where-cli add project Website
where-cli add task "Fix Firebase authentication" -p Website
where-cli add note "Homepage ideas" -b "Bigger search box" -p Website
where-cli add website "Flutter docs" --url https://docs.flutter.dev -t flutter
where-cli index ~/Documents/website -p Website    # index a folder into a project
where-cli search website auth
where-cli search kind:task login
where-cli show Website                            # an item and everything connected
where-cli list task
where-cli status "Fix Firebase authentication" done
where-cli link Alice involves Website
where-cli export -f md where.md
where-cli stats

Commands

Command	What it does
search <words> (s)	Search everything. Supports kind: filters. -l sets the number of results (default 25).
add <kind> <title> (new)	Create an item. -b text, -p project, --status, --url, -t tag (repeatable).
link <a> <relation> <b>	Connect two items: contains, involves or references.
unlink <a> <relation> <b>	Remove a connection.
show <item>	Show an item and everything connected to it.
list [kind]	Recent items, optionally of one kind. -l limit.
status <task> <status>	todo, in_progress (or doing), done.
delete <item> --yes	Remove from Where (never touches files on disk). --yes is required.
index [folder]	Index a folder (-p project, --include-hidden). No folder = refresh all.
export -f <format> <out>	json, md, csv (a folder of files) or sqlite.
stats	Counts of everything Where knows.
demo	Load the "Cybersecurity Lab" example and search it.

Items can be named by their exact title or their id.

Kinds: project, task, note, file, folder, person, application, website, conversation, calendar_event, device, bookmark, image, video, repository, organization.

Options for every command

Option	Meaning
--json	Print JSON instead of text, useful for scripts
--db <file>	Which database to use (or set WHERE_DB)

Using the same data as the app

By default the CLI uses its own database:

System	CLI default
Windows	%APPDATA%\Where\where.db
Mac	~/Library/Application Support/Where/where.db
Linux	~/.local/share/where/where.db

To work with the app's data, point it at the file shown in the app under Settings → Privacy → Database:

where-cli --db "<path from Settings>" search website
# or set it once:
export WHERE_DB="<path from Settings>"          # Mac / Linux
setx WHERE_DB "<path from Settings>"            # Windows (new terminals)

Close the app first if you plan to make lots of changes from the CLI.