Limai Docs
CLI Reference

columns

Column management commands

$limai columns <subcommand>

List, inspect, create and update the columns of a table.

Options
--jsonOutput raw JSON
--verboseEnable debug logging

Subcommands

limai columns list <tableId>

List the columns of a table, including their units and autoGenerateUnits flag.

limai columns list <tableId>

limai columns get <columnId>

Get details about a specific column.

limai columns get <columnId>

limai columns create <tableId>

Create one or more columns. Pass field flags for a single column, or --body <file> with a column object or { "columns": [...] }.

limai columns create <tableId> --name "Total Volume" --type NUMBER
limai columns create <tableId> --body columns.json

limai columns update <columnId>

Update a column. Field flags and --body share the same names as create; --labels and --units replace the stored lists.

limai columns update <columnId> --description "Litres delivered"

Field flags

Shared by create and update:

--name --slug --type --description --is-key on|off --is-list on|off --date-format EU|US|ISO --measurement-type --excluded-from-extraction on|off --pinned on|off --size <px> --default-value <json> --clear-default-value --default-value-enabled on|off --auto-generate-labels on|off --auto-generate-units on|off --labels a,b --units kg,g

Units on NUMBER_WITH_UNIT columns

A NUMBER_WITH_UNIT column must have at least one unit unless auto-generation is on. Without either, the extraction prompt would restrict the model to an empty list of units and every extracted value would be stored without one.

  • create refuses locally when --type NUMBER_WITH_UNIT is given without --units or --auto-generate-units on.
  • The API rejects any create or update that would leave the column in that state (switching the type, replacing units with an empty list, or turning auto-generation off on a unitless column) with 400 NUMBER_WITH_UNIT columns need at least one unit or autoGenerateUnits enabled.
limai columns create <tableId> --name "Price" --type NUMBER_WITH_UNIT --units EUR,USD
limai columns create <tableId> --name "Weight" --type NUMBER_WITH_UNIT --auto-generate-units on

Examples

View column details

limai columns get col_abc123

Get column details as JSON

limai columns get col_abc123 --json

Replace the units of a column

limai columns update col_abc123 --units kg,g,t

On this page