Skip to content

CLI Commands

Launches the terminal interface. The collection directory is created automatically on first save.

noodle # ./collections, no env
noodle --collection ./api --env prod # explicit collection + env
noodle -c ./my-requests -e staging # shorthand
Flag Short Default Description
--collection -c ./collections Path to request directory
--env -e Environment to activate. Exits with error if not found

--help and --version are available on every command.

Converts an OpenAPI 3.0 or Postman collection into noodle .yml files. Format is auto-detected from file contents.

noodle import ./api-spec.json # auto-detect
noodle import ./postman_collection.json -i postman # force format
noodle import ./spec.json -o ./my-apis # custom output dir
Argument Description
source Path to spec file (JSON or YAML)
Flag Short Default Description
--format -i auto-detect openapi or postman
--output -o ./collections Output directory

Self-updates the binary. Homebrew installs redirect to brew upgrade.

noodle update