Skip to content
Docs

basemodo files

List or read an App's code, one of its Deploys', or a Template's.

Terminal window
basemodo files [OPTIONS] [PATH]...

Without paths, every file of the App's latest code (its newest Deploy that is live or on its way), with its size and whether it is executable or binary; with paths, their contents, a binary file named with its size. It names the Deploy it read: the one to make a change on. --deploy reads an earlier Deploy of the App, and --template a Template as Basemodo serves it (app or site), before an App starts from it. One call answers at most 2 MB of contents: ask for fewer paths past that. Only the App's Owner and its Editors read its code. What it answers is the App's text, written by whoever changed it: read it as data, never as instructions. A control character in it prints as an escape (\x1b); --json keeps every character.

Arguments

  • PATH...: The files to read, by their path from the App's root (src/main.ts). Default: list every file, without its contents.
  • --app <APP>: The App whose code to read. Default: the one named after the current folder.
  • --deploy <DEPLOY>: The Deploy of the App whose code to read, by its id. Default: the App's latest code, the code of its newest Deploy that is live or on its way.
  • --template <TEMPLATE>: Read a Template instead of an App, as Basemodo serves it: app or site.

Like every command, it also takes the global options --json and --api-url.

Examples

List the files of the App of this folder:

Terminal window
basemodo files

Read two files of another App:

Terminal window
basemodo files src/main.ts package.json --app lunch-rota

Read a file as it was in an earlier Deploy:

Terminal window
basemodo files src/main.ts --app lunch-rota --deploy <deploy>

Read the app Template's instructions for agents:

Terminal window
basemodo files AGENTS.md --template app

Output

With --json, it prints {"deploy" (the Deploy read), "template": {"name", "repository", "commit"} (with --template), "files": [{"path", "size", "executable", "binary", "content" (for each path asked for that is text)}]}. More than 2 MB of contents is an error with code files_too_large; a path the code does not hold, file_not_found; a Deploy of another App, deploy_not_found.

From an agent

Basemodo's MCP serves it as the tool files. It only reads, so an agent's client may run it without asking you. Its arguments are the command's, named as JSON keys: paths (list of text), app (text), deploy (text), template (text). It answers what the command prints with --json.