CLI Commands
TUI (default)
Section titled “TUI (default)”Launches the terminal interface. The collection directory is created automatically on first save.
noodle # ./collections, no envnoodle --collection ./api --env prod # explicit collection + envnoodle -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.
Import
Section titled “Import”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-detectnoodle import ./postman_collection.json -i postman # force formatnoodle 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 |
Update
Section titled “Update”Self-updates the binary. Homebrew installs redirect to brew upgrade.
noodle update