Every NibWP CLI command, flag, file location and exit code, in one place.
Every command, flag and file the NibWP CLI uses. If you are setting it up for the first time, start with connecting from the terminal — this page is the lookup.
TL;DR
The installed command is nibwp. nibwp --help prints this list. Every command accepts --site, --all and --json.
Connecting
Command
What it does
nibwp auth login <url>
Sign in to a site through your browser and store the connection.
nibwp auth list
Every site connected, with what each may do.
nibwp auth status
Whether a connection is still valid and the site still reachable.
nibwp auth use <profile>
Set the site used when you do not pass --site.
nibwp auth logout
Revoke on the site and delete the local copy.
Options for auth login:
Flag
Effect
--name <profile>
Name this connection. Defaults to the site’s host name.
--scope read,write,manage,files,code
Ask for a specific set of permissions. Defaults to read and write.
--no-open
Print the approval link instead of opening a browser. For servers.
--timeout <ms>
How long to wait for the approval. Five minutes by default.
Working with a site
Command
What it does
nibwp discover [query]
List what the site can do, or rank it against a description of your task.
nibwp describe <ability>
What that ability expects, and what it returns.
nibwp run <ability>
Run it. Takes --input '<json>', --input @file.json, or --input - to read piped input.
nibwp workflow list | get | activate
The workflows available on that site.
nibwp upload <local> <remote>
Send a file to the site through a single-use link.
nibwp doctor
Check the connection end to end. --offline checks only your machine.
Files and repetition
Command
What it does
nibwp pull <remote dir> <local dir>
Fetch a directory to work on locally, recording what was fetched.
nibwp push <local dir>
Send back only what changed. Refuses if anything moved on the site; --force overrides, --dry-run shows the plan.
nibwp tape pull
Capture what was done recently into a file. --since 45m, -o file.json.
nibwp tape vars <file>
List the values a replay still needs.
nibwp replay <file>
Carry out the same steps here. --var k=v, --dry-run, --allow-code, --continue.
nibwp snapshot create
Save named post types and settings. --post-type, --options, -o file.json.
nibwp snapshot restore <file>
Put them back. --dry-run reports without writing.
Agents and editors
Command
What it does
nibwp agent add <client>
Write the connection into that editor. --project or --global.
nibwp mcp
Bridge an assistant that can only talk to local programs over the signed-in connection.
nibwp init
Write an AGENTS.md describing this site into the current folder.
nibwp guide get core
The guidance an assistant should read before driving the CLI.
~/.config/nibwp/config.json, or %APPDATA%nibwpconfig.json
Your tokens
credentials.json beside it, readable only by you
Both, somewhere else
Set NIBWP_CONFIG_DIR
Plain HTTP is refusedExcept for your own machine. A token sent unencrypted is readable by everything between you and the site. For an isolated development network, NIBWP_ALLOW_INSECURE_HTTP=1 allows it for a single command.
Exit codes
Useful in a script or a scheduled job.
Code
Meaning
0
Everything worked.
1
Something failed at runtime — including one site out of several.
2
The command was wrong: a missing argument, bad input, unknown option.
3
Not connected, or the site rejected the connection.
4
The site could not be reached, or answered with something unusable.
Requirements
Node.js 20 or newer — the installers check before doing anything.
NibWP active on the site, with AI Abilities switched on.
Administrator access to that site, to approve the connection.
Free and open source — GPL, no runtime dependencies, nothing downloaded when it runs.