Skip to main content

Init Command

The init command initializes a clean, zero-clutter Rumour workspace root. This prepares the directory structure and default configuration files for a new testing project.

Basic Usage​

rumour init [PATH] [OPTIONS]
  • [PATH] - Target directory to initialize the workspace (default: current directory .)

Options​

OptionShortDefaultDescription
--yesyfalseAutomatically accept prompts (e.g., automatically initialize a Git repository without asking)

Example​

Initialize in a new folder automatically without Git prompts:

rumour init ./new_testing_suite -y

Output:

⚙ Initializing Git repository...
Initialized empty Git repository in /home/user/new_testing_suite/.git/
✓ Git repository successfully initialized.

  Rumour workspace successfully initialized!
  Location: /home/user/new_testing_suite

  Created:
    • workspace.env.toml  (Workspace global variables & root marker)
    • new_testing_suite.config.toml  (Workspace global runner configuration)
    • new_testing_suite.suite.toml  (Workspace global ordered sequence suite)
    • .gitignore          (Configured to ignore local caches & reports)

  Next steps to start testing:
    1. Create a modular collection:   rumour new <collection_name>
       (Example: rumour new auth)
    2. Run your new workflow suite:   rumour run <collection_name>/<collection_name>.suite.toml
       (Example: rumour run auth/auth.suite.toml)

Use Cases​

Start a New Project​

Set up a brand new API testing workspace from scratch with the core architecture, environments, and Git configurations already generated for you.

Edge Cases & Behaviors​

Initializing inside an existing Git Repository​

If you run rumour init inside a folder that is already an initialized Git repository, Rumour will gracefully detect it, skip the Git initialization steps, and simply generate the workspace scaffolding:

mkdir -p /tmp/my_api && cd /tmp/my_api
git init
rumour init -y

Output:

hint: Using 'master' as the name for the initial branch. This default branch name
hint: will change to "main" in Git 3.0. To configure the initial branch name
hint: to use in all of your new repositories, which will suppress this warning,
hint: call:
hint:
hint: 	git config --global init.defaultBranch <name>
hint:
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint:
hint: 	git branch -m <name>
hint:
hint: Disable this message with "git config set advice.defaultBranchName false"
Initialized empty Git repository in /tmp/my_api/.git/

  Rumour workspace successfully initialized!
  Location: /tmp/my_api

  Created:
    • workspace.env.toml  (Workspace global variables & root marker)
    • my_api.config.toml  (Workspace global runner configuration)
    • my_api.suite.toml  (Workspace global ordered sequence suite)
    • .gitignore          (Configured to ignore local caches & reports)

  Next steps to start testing:
    1. Create a modular collection:   rumour new <collection_name>
       (Example: rumour new auth)
    2. Run your new workflow suite:   rumour run <collection_name>/<collection_name>.suite.toml
       (Example: rumour run auth/auth.suite.toml)

Notice that the ⚙ Initializing Git repository... phase is completely skipped, preserving your existing Git state perfectly.

Re-initializing an existing Workspace​

If you accidentally run rumour init in a directory that is already a Rumour workspace, it acts safely. It will not destructively overwrite your existing configurations. Instead, it fails gracefully with an exit code of 1:

rumour init -y
rumour init -y

Output:

⚙ Initializing Git repository...
Initialized empty Git repository in /tmp/my_api/.git/
✓ Git repository successfully initialized.

  Rumour workspace successfully initialized!
...

ℹ Rumour workspace already initialized in /tmp/my_api.