ekwo-os 0.9.0 → 0.11.0

package/README.md

@@ -60,7 +60,7 @@ either.
    It asks for the connection string, the country, the chart of accounts and
    the language where the pack offers a choice, your organisation, the
    currency, the first company, the address of the first administrator and —
-   optionally — the IBAN of your main bank account, then does the rest. Five
+   optionally — the identifier of your main bank account (an IBAN, a routing number and an account number, a sort code… whatever your country's banks use), then does the rest. Five
    to ten seconds on a free project. Nothing is preselected for you on the
    three questions whose wrong answer is expensive: the country, the chart and
    the language.
@@ -90,7 +90,7 @@ npx -y ekwo-os@latest init \
   --admin-email "you@example.com" \
   --admin-password "a-long-password" \
   --fiscal-year 2026 \
-  --iban "BE71096123456769" \
+  --bank-identifier "BE71096123456769" \
   --yes
 ```
 
@@ -151,7 +151,7 @@ first administrator, `init_instance()` and `claim_instance_admin()`, and
 nothing else. The instance row records no country. A flag that only describes
 a company — `--country`, `--company`, `--chart`, `--language`, `--currency`,
 `--fiscal-year`, `--fiscal-year-start`, `--vat-period`, `--filing-period`,
-`--iban`, `--bic`, `--bank-name` — is refused with it, exit code 2, before the
+`--bank-identifier` (and its old spelling `--iban`), `--bic`, `--bank-name` — is refused with it, exit code 2, before the
 database is touched: it would describe nothing.
 
 **`ekwo company new` is `create_company()`**, the function the `create_company`
@@ -274,7 +274,7 @@ and read by a person.
 | 1 | Applies `supabase/migrations/*.sql` in order | Recorded in `supabase_migrations.schema_migrations`, the Supabase CLI's own history table, so `supabase db push` and `ekwo migrate` stay interchangeable |
 | 2 | Applies every reference seed of `supabase/seed/`, in file-name order: `00_currencies.sql`, `00_territories.sql`, `05_framework_generic.sql`, then one `<n>_pack_<cc>.sql` per country pack, in the order of the number each pack declares | The currencies, the territories the tax rules name, the country-less financial statements every chart falls back on, and every country pack of the release — so a company in any of them can be created later without installing anything. They are exactly the seeds `supabase/config.toml` lists (a list `ekwo pack build` writes from `packs/`), so `supabase db push` installs the same set; a test compares both paths row by row. `90_demo_company.sql` is sample data and is never applied here |
 | 3 | Creates the first administrator through the Supabase Auth admin API | See below: a database connection cannot be a signed-in user |
-| 4 | `init_instance()`, `claim_instance_admin()`, the company, `company_members` as owner, `install_country_template()`, the first financial year, and the bank account when an IBAN was given | The six steps of the root README, in the same order, plus the one thing nobody can derive |
+| 4 | `init_instance()`, `claim_instance_admin()`, the company, `company_members` as owner, `install_country_template()`, the first financial year, and the bank account when an identifier was given | The six steps of the root README, in the same order, plus the one thing nobody can derive |
 | 5 | Writes `ekwo.json` | The installation: project URL and schema version. Nothing else, ever — no country, since each company carries its own. A file written by 0.6 or earlier also names a country; it is still read, and the key is taken for nothing |
 | 6 | Asks whether to register with Ekwo | The default answer is no, and no is a supported answer forever |
 
@@ -305,13 +305,13 @@ instead if the account already exists, and no key is needed.
 |---|---|
 | `ekwo init` | The whole installation, interactive or not: the socle's migrations, the reference seeds, then the modules', as `ekwo migrate` applies them. `--no-company` stops before the first company: see [several countries](#several-countries-in-one-installation-init---no-company). |
 | `ekwo migrate` | Applies the migrations this release adds, after showing the gap — the socle's, then the modules'. Re-applies the reference seeds, which are idempotent. `--no-modules` leaves the modules alone. |
-| `ekwo status` | Schema version installed against available, pending migrations, the instance, its administrators, the country packs it holds and, per company, the pack version it copied. Exits 1 when something is pending. |
+| `ekwo status` | Schema version installed against available, pending migrations, the instance, its administrators, the country packs it holds and, per company, the pack version it copied. On an installation that is not registered, a short invitation to [register](#registering-with-ekwo). Exits 1 when something is pending. |
 | `ekwo doctor` | Every object this release defines and every privilege it grants, against what the database holds; row level security on every table, a policy on every protected table, no pending migration, no membership pointing at a deleted user, every company with a bank account, statements that tie to their lines, posted entries that balance. Exits 1 on a problem, 0 on warnings. |
-| `ekwo register` | Opt in to security advisories and release notes. Also the retry when the announcement did not go through. |
+| `ekwo register` | Opt in to security advisories and release notes. Optional: everything works the same without it. Also the retry when the announcement did not go through. |
 | `ekwo unregister` | Opt back out. Clears the address and the date on the instance row. |
 | `ekwo demo` | Loads the sample company. Fictional data, explicit request only. |
 | `ekwo module` | What is installed beside the socle, applies a module's migrations and its country seeds, and turns one on or off for a company. |
-| `ekwo company` | `new` creates a company in its own country, through `create_company()`, and `list` shows the companies held here. One company leaves an installation with its books — `export` writes an archive anybody can read, as a member under row level security — and arrives in another one alive: `import` takes it in whole or not at all. |
+| `ekwo company` | `new` creates a company in its own country, through `create_company()`, and `list` shows the companies held here. `show` reads the company in use as the person signed in — its financial years, lock dates, journals and accounts by role — the same document as the MCP tool `get_company`. One company leaves an installation with its books — `export` writes an archive anybody can read, as a member under row level security — and arrives in another one alive: `import` takes it in whole or not at all. |
 | `ekwo pack` | Compiles a country pack into its seed, and refuses a seed that is no longer the output of its pack. Runs in a checkout of the repository only. |
 | `ekwo login` | Signs in to an instance as yourself and keeps the session, in your own configuration directory. See [acting as a person](#acting-as-a-person-login-use-whoami). |
 | `ekwo logout` | Ends that session, here and on the instance. |
@@ -671,13 +671,15 @@ for a statement. [`docs/import.md`](../../docs/import.md) is the long form.
 
 ## `ekwo module`
 
-A module is a Postgres schema beside the socle — `assets` for fixed assets,
-`budgets` for a plan against the ledger. Its migrations travel with this
-package, and `ekwo migrate` applies them by default.
+A module is a Postgres schema beside the socle — `fixed_assets` for fixed assets,
+`budgets` for a plan against the ledger, `tax` for the corporate income tax
+estimated from the books. Its migrations travel with this package, and
+`ekwo migrate` applies them by default.
 
 ```sh
 ekwo module list                          # what this release carries, and what the database holds
 ekwo module migrate [<code>]              # the migrations, and the country seeds they need
+                                          # (the code, `assets`, or the folder, `fixed-assets`)
 ekwo module enable assets --company "…"   # turn it on for one company
 ekwo module disable assets --company "…"  # turn it off; nothing it wrote is deleted
 ```
@@ -693,6 +695,14 @@ schemas. That is a setting of the API, not of the database, so `ekwo module
 enable` prints the line to add — Supabase dashboard → Project Settings → API,
 or `[api] schemas` in `supabase/config.toml`.
 
+**When a release renames a module's schema**, `ekwo migrate` applies the
+rename and says so: the exposed schemas of the project still name the old one,
+and only the operator can change that. The fixed assets module moved from
+`assets` to `fixed_assets` in its version 2.0.0 — replace one with the other in
+Project Settings → API. Its code, `assets`, is what `ekwo module` takes, and
+never changes; [`modules/fixed-assets/README.md`](../../modules/fixed-assets/README.md#upgrading-from-version-1-of-the-module)
+is the whole upgrade.
+
 **Before `supabase db push`**, run `ekwo migrate --no-modules`. The Supabase
 CLI knows the socle's migration files and not a module's, so it would report
 them as history it has no file for.
@@ -819,7 +829,8 @@ statements, the sentences the country requires on an invoice, the translations,
 and a year of books with the figures it produces. The compiler turns one into
 `supabase/seed/<n>_pack_<cc>.sql`, which is committed — and, where a pack
 carries a section for a module, into
-`supabase/seed/modules/<code>/<n>_pack_<cc>.sql`, applied by the module
+`supabase/seed/modules/<section>/<n>_pack_<cc>.sql` — `fixed_assets` for the
+fixed assets module — applied by the module
 migration runner and by nothing else.
 
 ```sh
@@ -920,8 +931,8 @@ dashboard under Connect → Session pooler, is the form that is never derived.
 | `--fiscal-year-start <date>` | The day that year opens, as `YYYY-MM-DD`. Needed only where the pack names no usual opening month (`defaults.fiscal_year_default`). |
 | `--currency <code>` | Currency of the company. Defaults to the pack's `defaults.currency`. |
 | `--language <xx>` | Language of the books, two letters. Defaults to `country_defaults.language_default`, which the pack fills. It decides which label of the pack lands on each account; the others are kept in `name_i18n`. |
-| `--iban <iban>` | Creates the main bank account, wired to the bank journal and its ledger account. Omitted, no bank account is created and `ekwo doctor` says so. |
-| `--bic <bic>` | Optional, on that account. |
+| `--bank-identifier <value>` | Creates the main bank account, wired to the bank journal and its ledger account. What it is written in is the country's: an IBAN, an ABA routing number and an account number (`"021000021 123456789"`), a sort code and an account number, a BSB, an IFSC, a CLABE… `ekwo pack describe <cc>` names it, and it is checked. A country whose pack declares none is asked for an account number as the bank wrote it. `--iban` is the old spelling and is refused where the banks do not use IBANs. Omitted, no bank account is created and `ekwo doctor` says so. |
+| `--bic <bic>` | Optional, on that account, for a bank that has one. |
 | `--bank-name <name>` | Optional. It also names the account in the books. |
 | `--demo` | Also load the sample company. |
 | `--register` | Register without being asked. `--register-email` sets the address. |
@@ -951,6 +962,7 @@ Every command takes `--json`; see [what a command answers](#what-a-command-answe
 | `EKWO_PROFILE` | `--profile` |
 | `EKWO_CONFIG_DIR` | Where profiles and sessions are kept. |
 | `EKWO_REGISTRY_URL` | `--registry-url`. Default `https://api.ekwo.ai/v1/registrations`. |
+| `EKWO_NO_REGISTER_INVITE` | Set to `1` to hide the invitation to register that `ekwo init` and `ekwo status` show on an installation that is not registered. The MCP server reads it too. |
 | `NO_COLOR` | Plain output. |
 
 See [`.env.example`](../../.env.example) at the root of the repository.
@@ -979,12 +991,24 @@ database the same way.
 
 ## Registering with Ekwo
 
-At the end of `ekwo init` you are asked:
+At the end of `ekwo init`, in a terminal, you are asked:
+
+> Register this installation with Ekwo, for security advisories that concern
+> your version and release notes? Everything works the same without it.
 
-> Register this installation with Ekwo to receive security advisories and
-> release notes?
+The default answer is no, and no is supported forever.
 
-The default answer is no, and no is supported forever. Community works
+Where nobody is asked — `--yes`, `--json`, a script — the end of `ekwo init`
+shows a short invitation instead, after everything else, and `ekwo status`
+shows the same one on an installation that is not registered: what registering
+gives, the six fields it sends and the one command,
+`npx -y ekwo-os@latest register --email <your address>`. Under `--json` it is
+the field `registration` of the document, `{ "registered": false,
+"invitation": { … } }`, and the standard output stays one document. It never
+waits for an answer, it disappears once the installation is registered, and
+`EKWO_NO_REGISTER_INVITE=1` hides it. The MCP server gives its agent one line
+to relay to the person, once, on the same terms; see
+[`docs/agents.md`](../../docs/agents.md#registering-the-installation). Community works
 unregistered: nothing in the schema and nothing in this CLI reads
 `contact_email` or `registered_at` to decide what you may do, and `edition`
 gates no feature.
@@ -1065,7 +1089,7 @@ node packages/cli/dist/bin.js init \
   --country BE --chart default --language fr \
   --org "Scratch" --company "Scratch BV" \
   --admin-email "you@example.com" --admin-password "a-long-password" \
-  --fiscal-year 2026 --iban "BE71096123456769" --yes
+  --fiscal-year 2026 --bank-identifier "BE71096123456769" --yes
 
 # 2. Everything should be green, and nothing pending.
 node packages/cli/dist/bin.js status --db-url "$URL"