Skip to main content

New Command

The new command scaffolds a new modular testing collection inside your existing Rumour workspace.

Basic Usage​

rumour new <NAME> [OPTIONS]
  • <NAME> - Name of the new collection folder (e.g., auth or users)

Options​

OptionShortDefaultDescription
--yesyfalseAutomatically accept default configuration prompts

Example​

Create an authentication collection:

rumour new auth

Output:

  Collection 'auth' successfully created!
  Location: /home/user/workspace/auth

  Scaffolded:
    • auth/auth.env.toml (Domain environment overrides)
    • auth/auth.config.toml (Domain runner configurations)
    • auth/auth.suite.toml (Ordered sequence runner suite)
    • auth/requests/                 (Subfolder for API request TOMLs)
        └── requests/example.toml    (Documented template request)

  To run this collection's test suite:
    $ rumour run auth/auth.suite.toml

Scaffold Automatically (Non-Interactive)​

If you are scripting the creation of a workspace or running inside a CI/CD pipeline, use the -y flag to automatically accept any configuration prompts without blocking execution:

rumour new products -y

Use Cases​

Expand Test Suites​

Add a new logical grouping for your API requests with its own isolated environment configurations and suite runners natively scaffolded.

Edge Cases & Behaviors​

Scaffold an Existing Collection Name​

If you attempt to scaffold a collection that already exists within your workspace, the command will exit gracefully (Exit Code 0) without overwriting any of your existing request files or configurations:

rumour new auth
rumour new auth

Output:

  Collection 'auth' successfully created!
  Location: /tmp/my_api/auth

  Scaffolded:
    • auth/auth.env.toml (Domain environment overrides)
    • auth/auth.config.toml (Domain runner configurations)
    • auth/auth.suite.toml (Ordered sequence runner suite)
    • auth/requests/                 (Subfolder for API request TOMLs)
        └── requests/example.toml    (Documented template request)

  To run this collection's test suite:
    $ rumour run auth/auth.suite.toml

ℹ Collection folder 'auth' already exists in your workspace.

Nested Collections​

Rumour fully supports scaffolding deeply nested collections to create complex organizational hierarchies. The command intelligently parses the path to name the config files after the deepest folder:

rumour new payments/stripe/webhooks

Output:

  Collection 'payments/stripe/webhooks' successfully created!
  Location: /tmp/my_api/payments/stripe/webhooks

  Scaffolded:
    • payments/stripe/webhooks/webhooks.env.toml (Domain environment overrides)
    • payments/stripe/webhooks/webhooks.config.toml (Domain runner configurations)
    • payments/stripe/webhooks/webhooks.suite.toml (Ordered sequence runner suite)
    • payments/stripe/webhooks/requests/                 (Subfolder for API request TOMLs)
        └── requests/example.toml    (Documented template request)

  To run this collection's test suite:
    $ rumour run payments/stripe/webhooks/webhooks.suite.toml

Folder Names with Spaces​

While not recommended for CLI usability, Rumour correctly handles directory names containing spaces when generating configurations:

rumour new "legacy api"

Output:

  Collection 'legacy api' successfully created!
  Location: /tmp/my_api/legacy api

  Scaffolded:
    • legacy api/legacy api.env.toml (Domain environment overrides)
    • legacy api/legacy api.config.toml (Domain runner configurations)
    • legacy api/legacy api.suite.toml (Ordered sequence runner suite)
    • legacy api/requests/                 (Subfolder for API request TOMLs)
        └── requests/example.toml    (Documented template request)

  To run this collection's test suite:
    $ rumour run legacy api/legacy api.suite.toml