@fairmint/captable-ai 0.1.26 → 0.1.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -0
- package/dist/index.js +2739 -2331
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -99,6 +99,7 @@ automated, but a few habits make extraction faster and more accurate:
|
|
|
99
99
|
| `commit` | Commit drafts to the cap table — `--all` or `--objects id1,id2` (`--dry-run` to preview) |
|
|
100
100
|
| `summary` | Full cap table snapshot |
|
|
101
101
|
| `export` / `register` | Export the cap table (Excel) / shareholder register (`--include-equity-awards` adds option grants) |
|
|
102
|
+
| `export stock\|grants\|warrants\|convertibles` | One instrument register, one row per security (Excel link by default; `--csv` / `--json` for rows) |
|
|
102
103
|
| `pro-forma run` | Model financing, convertible, warrant, and option-pool scenarios |
|
|
103
104
|
| `retrigger-validation` | Re-queue a stalled validator |
|
|
104
105
|
| `jobs list\|get\|prune` | Track async operations |
|
|
@@ -110,6 +111,33 @@ automated, but a few habits make extraction faster and more accurate:
|
|
|
110
111
|
Run `captable-ai <command> --help` for full usage, or `captable-ai commands --json` for the
|
|
111
112
|
authoritative machine-readable list.
|
|
112
113
|
|
|
114
|
+
## Instrument registers
|
|
115
|
+
|
|
116
|
+
`captable-ai export` with no register is the full legal cap table: a multi-sheet Excel
|
|
117
|
+
workbook returned as a one-hour download link. Four registers export one instrument
|
|
118
|
+
family, one row per security:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
captable-ai export stock # Excel download link
|
|
122
|
+
captable-ai export grants --include-pending # options, RSUs, other awards
|
|
123
|
+
captable-ai export warrants --json # rows as a JSON array
|
|
124
|
+
captable-ai export convertibles --type SAFE --csv # SAFEs only, CSV on stdout
|
|
125
|
+
captable-ai export convertibles --type NOTE --json --output notes.json
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Every register starts with the holder fields (name, email, address, country, state),
|
|
129
|
+
then the economics of that family. Without a format flag the result is one Excel sheet
|
|
130
|
+
returned as a download link. `--csv` prints RFC-4180 CSV whose header row is the JSON
|
|
131
|
+
keys; `--json` prints the rows as a JSON array. Pass one or neither. `--output <path>`
|
|
132
|
+
writes the CSV or JSON body to a file and, for these commands only, does not imply
|
|
133
|
+
`--json`.
|
|
134
|
+
|
|
135
|
+
By default a register lists the committed cap table only. `--include-pending` adds what
|
|
136
|
+
is not committed yet: draft OCF objects, plus `investment` and `equity_grant` rows that
|
|
137
|
+
have no OCF transaction. A row that already has an OCF object appears once. Registers
|
|
138
|
+
are read-only and never commit drafts. You must be an owner or admin of the active
|
|
139
|
+
company.
|
|
140
|
+
|
|
113
141
|
## Structured output
|
|
114
142
|
|
|
115
143
|
Pass `--json` to any command for machine-readable output. Data goes to stdout, errors go
|