Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pome.sh/llms.txt

Use this file to discover all available pages before exploring further.

.pome.json is the project-level configuration file for the pome CLI. Place it in your project root and the CLI reads it automatically — no flags required. Every pome command walks up the directory tree from the current working directory until it finds a .pome.json file, so nested projects and monorepos work without any extra setup.

​
File location

The CLI searches for .pome.json starting from the directory where you run the command and walking up toward the filesystem root. This means you can run pome run from any subdirectory of your project and it will find the right config.
Override the config file path at any time with the --config flag:
pome run scenarios/ --config path/to/custom.pome.json

​
Modes

Pome operates in one of two modes, controlled by the mode field. Choose the mode that matches your deployment.
In oss mode, the CLI talks directly to a locally running twin rather than the hosted control plane. Use this mode during development or when running Pome in a self-hosted environment.
.pome.json
{
  "mode": "oss",
  "twins": {
    "github": {
      "url": "http://localhost:3333"
    }
  }
}
The twins.github.url field tells the CLI where to find the GitHub twin. Boot the twin with pome twin or your own Docker setup before running scenarios.

​
Configuration reference

FieldTypeDefaultDescription
mode"oss" | "hosted""oss"Deployment mode. oss targets a local or self-hosted twin; hosted targets the Pome cloud.
twins.github.urlstring"http://localhost:3333"Base URL for the GitHub twin REST surface. Only used in oss mode.
Commit .pome.json to version control. It contains no secrets (API keys belong in environment variables) and gives every team member a consistent starting point without any local configuration.