Docs

Documentation

To run your finance today, start on Ekwo Cloud; these pages are Ekwo OS, the open source core it runs on. Every page here is a file of the repository, rendered when the site is built, so it says what the code in the same release does. What is not written yet says so.

Start here

What Ekwo OS is, and one command from a free Supabase project to a first invoice.

  • Ekwo OS, in one page

    Ekwo is open source accounting, ready to use on Ekwo Cloud: the web application for your invoices, your bank statements, your VAT returns and the electronic invoices your country…

  • Start with Claude: try Ekwo on your own company data

    Already using Claude? A free Supabase project, one command, the MCP server connected in Claude Desktop or Claude Code — then your own company data taken over, questioned and a VAT…

  • For an AI agent helping somebody use Ekwo OS

    What an AI agent needs to set Ekwo OS up for somebody and run their finance: where to read, the commands and the tools, and what it must never do.

  • Install Ekwo OS on your own Supabase project

    From a free Supabase account to a first invoice: one command applies the schema, seeds the country rules and creates the first company — then the four settings no installer can…

Run your finance

The command line, the MCP server an agent connects to, the TypeScript client and the format libraries.

Countries

A country is a pack of files, not code. How one is written, translated and checked.

  • Country packs

    A country is data. Everything Belgium or France adds to Ekwo — a chart of accounts, journals, VAT codes, the accounts each of them posts to, the boxes of the periodic return — is…

  • Languages

    Accounting is done in a language. A Belgian company keeps its books in French, in Dutch or in German; its accountant reads the chart of accounts in one of them, and the National…

  • Ekwo OS in every country

    A country is data, not code. A module of code per country breaks at every major version, and one product per market splits the users. Ekwo OS ships one core and one versioned pack…

Running a business on it

Filing a declaration, a firm and its clients, sharing a document, moving a company, and the modules.

  • The life of a declaration

    A tax return is not a report. A report is asked for and answers; a declaration leaves the building, an administration keeps a copy, money follows it, and months later somebody…

  • An accounting firm and its clients

    An accounting firm, a fiduciary, a bookkeeper with thirty customers, a group that keeps the books of its three subsidiaries: somebody who keeps several companies that are not all…

  • Sharing a document

    A company sends an invoice and the customer wants to look at it: what it says, what is still owed on it, what the law put at its foot. Everything needed to answer already exists…

  • The archive of one company

    A firm keeps the books of N companies in one installation, and each of them belongs to somebody. export_company() writes one company out, whole, in a format that needs nothing of…

  • Taking over company data kept elsewhere

    Somebody who wants to try Ekwo on their own books arrives with them. They come from another package, or from nowhere in particular — a spreadsheet — and what they hold is the same…

  • Modules

    The socle is public: companies, accounts, taxes, entries, documents, the reports. What is built beside it lives here, one folder and one schema per module.

Reference

Every table and function, the mapping to the standards, and every design decision with its reason.

Contributing

How a pull request gets in, how a module is written, how the data is tested at volume, how a release is cut.

  • Contributing to Ekwo OS

    Thank you for being here. This file is short and every line of it is a rule that has cost somebody a day.

  • Writing a module

    A module is a Postgres schema beside the socle. fixed_assets holds fixed assets and their depreciation; budgets holds a plan and compares it to the ledger; tax estimates the…

  • Company data at volume

    How the schema behaves when there is something in it, how that is checked, and what is still to be measured.

  • How a release is cut

    A release of Ekwo OS is one tag carrying the migrations, the country packs and the npm packages together. There is no "down": a database that has run a migration cannot be walked…

About Ekwo

Why it is being built, what it does not promise, and where to report a flaw.

  • Why we are building Ekwo

    Every business on earth keeps books. The books say whether it is alive, whether it can pay its people next month, whether it can afford to try something. For most small…

  • What Ekwo is, and what it is not

    Ekwo OS is open source data infrastructure: a database schema, rules written as data, format libraries and tools, for businesses and for the accountants who work with them. It is…

  • What Ekwo knows about you

    Ekwo is one piece of software, and you choose where your books live. The same open-source schema runs everywhere; what changes is who operates the database, and what Ekwo holds…

  • Reporting a flaw

    Ekwo OS holds books. A flaw here is not a crash, it is a company reading another company's ledger, or an entry that posts without a trace. Please report it, and please report it…