Recordful Help
AI agents

Command line

Use recordful-mcp from a terminal or any agent with a shell: record, upload, list videos and read transcripts, with JSON output.

The same abilities as the MCP tools, for people and agents that prefer a shell. Click the Recordful icon on the tab to record first.

npx -y recordful-mcp start
npx -y recordful-mcp stop
npx -y recordful-mcp upload --title "Sign-up demo"
npx -y recordful-mcp transcript > transcript.txt
npx -y recordful-mcp videos

The first command asks you to click the Recordful icon once. A small background helper then keeps Recordful's connection for later commands and exits after 30 idle minutes.

Commands

CommandWhat it doesPlan
start [--tab <id>]Start recording with your Recordful settingsFree and Pro
pause, resumePause or resumeFree and Pro
stopStop; says where the recording wentFree and Pro
recordingsRecordings saved on this computerFree and Pro
statusConnection, recorder, account and pairing stateFree and Pro
upload [<takeId>] [--title t] [--visibility private|workspace|public] [--force] [--no-wait]Upload a recording and print its linksPro
videos [--limit n] [--query text]List your videosPro
video [<videoId>] [--wait]One video's links and upload stagePro
transcript [<videoId>] [--format text|vtt|json] [--no-wait]Print what was saidPro
update [<videoId>] [--title t] [--visibility private|workspace|public]Rename a video or change who may watchPro
activity [<videoId>]Views, likes and commentsPro
comment [<videoId>] --body <text>Post a comment as you (public to viewers)Pro
like [<videoId>] [--undo]Like or unlikePro
foldersList your foldersPro
folder-create <name> [--parent <folderId>]Create a folderPro
move <videoId>... [--to <folderId>]Move videos into a folder (no --to: the top level)Pro
delete <videoId> --yesDelete a video permanently; --yes confirms that exact videoPro
storageCloud storage usedPro
call <method> [json]Call one Recordful method directly, such as page.clickFree and Pro
install --target <app> [--yes]Add Recordful to an AI app's configurationnone
unpair [<id>|--all]Forget a paired Recordfulnone
setup, prompt, guide --jsonSetup steps, the setup prompt, and a description of everything for agentsnone

Without a video or recording ID, commands use the last recording.

Output and exit codes

  • Add --json to any command for machine-readable output on stdout. Progress and hints go to stderr.
  • Exit code 0 is success, 1 is a failure (the error code is in the message, for example PRO_REQUIRED), and 2 means a transcript isn't ready yet. That is not a failure: retry, or leave off --no-wait.

npx -y recordful-mcp guide --json prints tools, commands, error codes, plans and safety rules in one document. An agent should read that instead of relying on remembered commands.

On this page