The console

The app's console runs Rufineer's commands on the model's files: checking it, explaining a line, showing what the conventions write, formatting, generating modules and lines, making the data workbook and the export.

Overview

The console is the panel under the editor in the app. Open it with ⌘K (Ctrl+K on Windows and Linux) or the Console button above the editor; Esc or × closes it. Type a command and press Enter: it runs on the model's files as they are in the editor, saved or not, and prints what it did. A command that changes files changes them in the editor too, and lists them under its output: click one to open it.

Output

check                  compile; report the problems       generate …       add a module or a line
explain <line>         where a line lands in Excel        fmt [paths]      format .rfn files
conventions [m]        what Rufineer writes               data             make or extend the data workbook
build                  Export to Excel (Pro)              help             this list

The commands are the ones the rfn command line had, written the same way, so rfn in front is optional: rfn check and check do the same. As you type, the console suggests the commands that fit; Tab completes the one picked, and ↑ and ↓ go through the commands you ran before. Clear empties it.

Everything is free except build, the export, which needs Pro. Commands shows where each one is in the rest of the app.

generate

Output

generate module <name> ["Title"]
generate <kind> <name> [--in <module>]      # kind: revenue cost cost_of_sales income capex loan reserve
generate dashboard
generate case [input]

g is short for generate. A module is one file, <name>.rfn: a commented-out inputs block to fill in, then the module, and its name added to sheets in model.rfn. A line of a kind goes into the module it belongs in (ops for revenue and costs, capex, debt for loans and reserves; --in another), at the end of the module in its file, and its inputs, with placeholder numbers, into the inputs block above it (a loan's in a block of its own); the model still builds. dashboard writes a dashboard into reports.rfn from the model's own lines; case adds a sensitivity case there that moves an input by +10% and −10%. In a model in the first layout (inputs/ beside calculations/), the generators write there, as before. Each prints what it created, inserted or updated (Project layout), and the new module or line opens in the editor. ＋ Generate, beside the Console button, does the same from a form.

check

Output

check

Compiles the model and prints its problems: unit errors, misspelt names (with suggestions), loops not declared with solve, missing data-workbook sheets. Warnings are printed too. The editor underlines the same problems as you type, and the preview's Problems tab lists them.

fmt

Output

fmt [files or folders] [--check]

Formats .rfn files the standard way (the whole model by default): indentation, spacing, and names, units, =, labels and notes lined up in columns. Only spaces, blank lines and line breaks change. --check changes nothing: it lists the files that aren't formatted. Format Document (⇧⌥F; Shift+Alt+F) formats the file in the editor.

explain

Output

explain <line>

Where a line lands in the workbook, its unit, its Excel formula for the first period, what it reads and what reads it: the audit panel, in text.

Terminal

$ rfn explain ops.energy
ops.energy  "Energy"
  where   Ops!H24 (first period; the same formula runs across the row)
  unit    MWh
  formula =$D$10*$D$11*$D$12*H$23*H$15*8760*H$16
  read by ops.sales

conventions

Output

conventions [module]

Prints what the conventions write for the model, as Rufineer: all of it, or one sheet (sources, assets, tax, income, cashflow, balance, returns). The preview's Conventions tab shows the same. Copy a line into your own module of that name to change it.

data

Output

data

Makes the data workbook named in model.rfn (data/tables.xlsx), or adds a sheet for each table it doesn't have yet, with the headers and, for a profile, a row per period. Values already typed in are kept. Open the workbook from the file tree to see its sheets, with the cells the model reads shaded; Add the missing sheets there does the same as data. To fill it in, choose Download, type the values in Excel and save, then Replace… it with your copy (or drop the file on the page): the model reads it again at once.

build

Output

build [--exclude-macros]

With Pro: the same as Export to Excel at the top right of the app. Rufineer's service compiles the model, solves it and writes the lender-grade workbook, and your browser downloads it as <model>.xlsm: FAST layout, live formulas, solved, with the Solve and Run sensitivities macros and their buttons. --exclude-macros writes a plain .xlsx without macros, as Export without macros (.xlsx) in the menu (☰) does. A model with errors isn't exported: the preview's Problems tab shows why. Without Pro it says so, and how to subscribe.

help

Output

help

Lists every command and its options.