BROWSE DOCS
REFERENCE
DOCS / CLI

finowl rename

Changes the project name on the platform and in finowl.yml in one act. The only sanctioned way to rename a project, and the only one that keeps the two in agreement.
finowl rename NEW_NAME [OPTIONS]

  -b, --bundle PATH   Path to the databricks.yml bundle file.  [default: databricks.yml]
  -p, --profile TEXT  Authentication profile to act as.  [env: FINOWL_CONFIG_PROFILE]
finowl rename finance-reporting
Renamed to finance-reporting.
Identity, run history, budget, rules and estimate links are unchanged.

Why a command and not an edit

The registered name lives in two places: on the platform and in finowl.yml. Editing the file alone puts them out of agreement, and finowl guard fails on that drift by design.

Drift is refused rather than reconciled because reconciling it means guessing which side is right, and the wrong guess silently moves a bundle onto another project's history.

╭─ Name drift ─────────────────────────────────────────────────────╮
│ finowl.yml says finance-reporting, but this project is           │
│ registered as reporting-q3.                                      │
│ Run `finowl rename finance-reporting` to make it official,       │
│ or revert the file.                                              │
╰──────────────────────────────────────────────────────────────────╯

breakdown reports drift as a warning; guard exits 1.

What a rename keeps

  • The identity — estimation.id never changes, and reports are filed under it.
  • Every past run, on every deployment.
  • The budget and the committed baseline.
  • Attached policies and rules.
  • Linked estimates and their versions.

Because identity is an opaque id rather than a name or a repository URL, none of this depends on what the project is called.

Platform first, file second

The rename is applied on the platform, and finowl.yml is written only after it succeeds. The reverse order would leave the file claiming a name the platform never accepted.

If the file write fails after the platform accepted the rename, the result is name drift — which guard already catches and tells you how to fix. A failure mode that lands in an already-detected state is a better failure mode than one that does not.

When the name is taken

$ finowl rename analytics
Name taken: Customer analytics already uses 'analytics' in your workspace.
https://portal.finowl.cloud/products/6f1c9a2e-...

Nothing changes on either side, and the error links the project holding the name so you can check whether it is the one you meant. Names are unique per workspace: two bundles sharing one name is how reports get mixed.

Other errors

MESSAGECAUSE
Unknown project: <id> does not exist in your workspaceThe identifier in finowl.yml names a project that was deleted, or the credential is for another organization.
A project name is requiredAn empty or whitespace-only argument.
<path>: missing the estimation identity blockThis bundle was never registered. Run finowl init --target <t> first.

Rename versus the display label

NOTE
The display label on the board is a separate, cosmetic field. Any authorized user can change it from the web app without touching identity, history or the registered name — and without needing the repository. Use renamewhen the project's registered name should change; edit the display label when only the board should read differently.