Skip to content

Command reference

maypop --help and maypop <command> --help always show the installed version’s exact flags. This page describes CLI v0.5.2.

Every command accepts:

Option Environment Meaning
--profile <NAME> MAYPOP_PROFILE Use a saved profile instead of the default
-u, --url <URL> MAYPOP_URL Talk to a different Maypop server
-t, --token <TOKEN> MAYPOP_TOKEN Use this access token instead of the saved one
-V, --version Print the version

MAYPOP_CONFIG_DIR moves where credentials are stored.

Sign in through your browser. Needs the Pro plan.

Flag Meaning
--no-browser Print the approval link instead of opening it
--device-name <NAME> Name shown on the approval page and in CLI access

Check that Maypop is reachable and which account is signed in. Changes nothing.

maypop profile list / maypop profile set-default <NAME>

Section titled “maypop profile list / maypop profile set-default <NAME>”

List saved profiles, or choose the one used when --profile is left out.

Create a new Maypop app for a folder (default .), set Maypop’s Git server as origin, and write maypop.toml. Doesn’t publish.

Flag Meaning
-n, --name <NAME> App name; defaults to maypop.toml, then the folder name
-d, --description <TEXT> App description
--visibility <V> private (default), unlisted or public

Stops if the folder already belongs to an app or already has an origin.

Build the committed HEAD, push it, and publish it as the app’s next version. Refuses uncommitted changes and builds that modify tracked files. See Publish from your repository.

Flag Meaning
--changelog <TEXT> A release note for this version

Send the [app] table of maypop.toml — name, description, reach, remixing, category, thumbnail — to Maypop. Uploads the thumbnail first. Only fields present in the file change.

Show the app this repository is connected to. Changes nothing.

Point the repository’s origin at the app’s own repository on Maypop and push the current commit, without publishing a version. Use it when Maypop tells you an app’s repository has moved.

Download the published source of another app you can open, into .maypop/local/references/, to learn from or copy parts of. The source app must allow it. Your app, its identity and its remote are untouched, and the reference folder is ignored by Git and never published.

Flag Meaning
--path <DIR> Your app’s folder (default .)

Each command is one paid generation that writes one file, billed in credits. It never overwrites a file unless you pass --force. Full guide: Generate images, audio and video.

maypop ai image --prompt <TEXT> --output <FILE.png>

Section titled “maypop ai image --prompt <TEXT> --output <FILE.png>”
Flag Meaning
--tier <T> fast (default) or quality
--size <SIZE> Preset (default 2K) or WIDTHxHEIGHT

maypop ai audio --prompt <TEXT> --output <FILE.mp3|.wav>

Section titled “maypop ai audio --prompt <TEXT> --output <FILE.mp3|.wav>”
Flag Meaning
--format <F> mp3 or wav; defaults to the file extension

maypop ai video --prompt <TEXT> --output <FILE.mp4>

Section titled “maypop ai video --prompt <TEXT> --output <FILE.mp4>”
Flag Meaning
--model <M> fast (default, up to 15 s) or quality (up to 30 s)
--duration <SECS> Default 5
--resolution <R> 480p or 720p (default)
--ratio <R> 16:9 (default), 9:16, 4:3, 3:4, 1:1, 21:9
--generate-audio Add synchronised sound
--seed <N> Repeatable results

See MCP from the command line for examples.

Command What it does
maypop mcp list [--json] Servers connected to your account
maypop mcp connect <NAME> <URL> [--header-env HEADER=ENV_VAR] Connect a custom HTTPS MCP server
maypop mcp disconnect <INTEGRATION> Remove a connection and all its app links
maypop mcp tools <INTEGRATION> [--app] [--json] Show the live tool list and input schemas (alias docs)
maypop mcp call <INTEGRATION> <TOOL> [--arguments JSON] [--app] Run a tool and print its raw result
maypop mcp linked [--json] Servers linked to this repository’s app
maypop mcp link <INTEGRATION> Give this app access to one of your servers
maypop mcp unlink <INTEGRATION> Remove this app’s access

<INTEGRATION> is an id, or a name when it’s unique.

Read-only: status, info, profile list, mcp list, mcp linked, mcp tools.

Everything else changes something — your credentials, your repository’s Git setup, your app on Maypop, your credits, or an external service through mcp call. A coding assistant should ask before running them.