Harumi

Platform Tour

Documentation, Code, Data Sources, Secrets, and Harumi AI Chat, section by section.

Documentation

The Documentation tab holds markdown documents for the project — design notes, business rules, or anything you want alongside the code. Documents are plain .md files committed to the same repository as your code.

Click New doc in the sidebar, give it a name (.md is appended if you leave it off), and start writing. Each document has three view modes:

Read-only rendered markdown, including fenced code blocks and math.

Saving a document commits it to the repository, the same as editing a file in the Code tab.

Code

The Code tab is a browser view of the project's git repository: a file tree on the left, and a viewer/editor on the right.

  • Clone URL — copy it from the top of the Code tab to git clone the project locally, or use the harumi CLI to bind a local directory to the project.
  • Download .zip — grab a snapshot of the current branch without cloning.
  • Branches — the New version button creates a new branch to work on changes without touching main. Harumi always runs main, so merge a branch back into it (via git) to make it live.
  • Editing a file — select a file, switch to Edit, make your change, and click Commit changes. Edits go straight to the branch you're viewing — there's no separate draft/publish state.

Adding data files

There's no upload button in the Code tab today. To add a CSV, Parquet, or other data file to a project, git push it — either by cloning the repo directly, or with harumi run from the CLI, which pushes your local working tree (including new files) to a scratch branch automatically.

Data Sources

Data Sources connects a project to an external database so your code can query it directly, without embedding credentials in your repository. Supported types: PostgreSQL, MySQL, SQL Server, and Oracle.

To add one, click Connect new data source and fill in the connection details (host, port, database, username, password). If the database isn't reachable directly, enable Connect through a proxy to route the connection through Harumi's VPN proxy, providing the proxy host/port and mTLS certificates. Click Test connection before saving — Harumi verifies connectivity before persisting the data source.

Once connected, query it two ways:

  • From your code — the data source is available to your run via its name.
  • From the SQL Editor in the Data Sources tab — a read-only editor (SELECT/WITH only) for quick exploration.

Secrets

Settings → Secrets stores environment variables for your project's code — API keys, credentials, or any other config value you don't want committed to the repository in plain text. Values are encrypted at rest and are never shown again after saving; you can only replace or delete them, not view them.

Click Add secret, provide a name and value, and it becomes available as an environment variable the next time your project runs.

Harumi AI Chat

Chat opens Harumi AI Chat, available as a drawer from any tab or as its own full page. It has two modes:

  • Agent — full agentic mode. Routes optimization requests to a dedicated solver that builds a model and runs code, and can also answer general questions.
  • Ask — conversational mode. Searches your project's files and can run code to answer questions, but does not route to the optimization solver.

In either mode, the chat can read and write files in your project's repository and execute code, shown inline as step cards (code execution output, file reads/writes) as it works.

Dashboard

Dashboard is the default tab and shows:

  • Latest run — widgets declared in dashboard.toml, rendered from the most recent run's output/output.json.
  • Recent runs — a list of past runs; click one to open its output.
  • View latest output — a live terminal showing stdout/stderr while a run is in progress, and the full log once it finishes.
  • Execution history — every run for the project, with status and timestamps.
  • Schedule — configure a cron schedule to run the project automatically. Scheduled runs always use the main branch.

On this page