nocodb

NocoDB CLI

NocoDB API 用の CLI です。

プラットフォームのサポート

• Linux / macOS: scripts/nocodb.sh（Bash。curl と jq が必要です）

以下のすべての例では、（このスキルのディレクトリを基準とした）scripts/nocodb.sh を実行します。スタンドアロンの nc バイナリはありません。また、nc は netcat ユーティリティであるため使用しないでください。

プランの要件

FREE PLANS： Base、Table、Field、Record、Link、Attachment API、フィルター、Sorts API

ENTERPRISE（セルフホストまたはクラウドホスト）： Workspace、Workspace Collaboration API、Base Collaboration API、View、Script、Team、API Token API

セットアップ

export NOCODB_TOKEN="your-api-token"
export NOCODB_URL="https://app.nocodb.com"  # optional, this is default
export NOCODB_VERBOSE=1                      # optional, shows resolved IDs

API トークンを取得します：NocoDB → Team & Settings → API Tokens → Add New Token。

引数の順序

コマンドは階層型のパターンに従います。引数は常に次の順序で指定します。

WORKSPACE → BASE → TABLE → VIEW/FIELD → RECORD

名前（人が読みやすい形式）または ID（NocoDB から取得でき、より高速）を使用できます。

ID の接頭辞： w=workspace、p=base、m=table、c=column、vw=view

例：

• 名前：scripts/nocodb.sh record:list MyBase Users
• ID：scripts/nocodb.sh record:list pdef5678uvw mghi9012rst

解決された ID を確認するには、NOCODB_VERBOSE=1 を設定します：

NOCODB_VERBOSE=1 scripts/nocodb.sh field:list MyBase Users
# → base: MyBase → pdef5678uvw
# → table: Users → mghi9012rst

クイックリファレンス

# Workspace APIs (Enterprise only)
scripts/nocodb.sh workspace:list                                   # → wabc1234xyz

# Free plan APIs
scripts/nocodb.sh base:list wabc1234xyz                            # → pdef5678uvw
scripts/nocodb.sh table:list pdef5678uvw                           # → mghi9012rst
scripts/nocodb.sh field:list pdef5678uvw mghi9012rst               # → cjkl3456opq
scripts/nocodb.sh record:list pdef5678uvw mghi9012rst
scripts/nocodb.sh record:get pdef5678uvw mghi9012rst 31
scripts/nocodb.sh filter:list pdef5678uvw mghi9012rst vwmno7890abc

# View APIs (Enterprise only: self-hosted or cloud-hosted)
scripts/nocodb.sh view:list pdef5678uvw mghi9012rst                # → vwmno7890abc

# Filter syntax help
scripts/nocodb.sh where:help

コマンド

ワークスペース

注： Workspace API と Workspace Collaboration API は、セルフホスト型 Enterprise プランおよびクラウドホスト型 Enterprise プランでのみ利用できます。

scripts/nocodb.sh workspace:list                         # → wabc1234xyz
scripts/nocodb.sh workspace:get wabc1234xyz
scripts/nocodb.sh workspace:create '{"title":"New Workspace"}'
scripts/nocodb.sh workspace:update wabc1234xyz '{"title":"Renamed"}'
scripts/nocodb.sh workspace:delete wabc1234xyz
scripts/nocodb.sh workspace:members wabc1234xyz
scripts/nocodb.sh workspace:members:add wabc1234xyz '{"email":"[email protected]","roles":"workspace-creator"}'
scripts/nocodb.sh workspace:members:update wabc1234xyz '{"email":"[email protected]","roles":"workspace-viewer"}'
scripts/nocodb.sh workspace:members:remove wabc1234xyz '{"email":"[email protected]"}'

ベース

scripts/nocodb.sh base:list wabc1234xyz                  # → pdef5678uvw
scripts/nocodb.sh base:get pdef5678uvw
scripts/nocodb.sh base:create wabc1234xyz '{"title":"New Base"}'
scripts/nocodb.sh base:update pdef5678uvw '{"title":"Renamed"}'
scripts/nocodb.sh base:delete pdef5678uvw

Base Collaboration（Enterprise プランのみ）

scripts/nocodb.sh base:members pdef5678uvw
scripts/nocodb.sh base:members:add pdef5678uvw '{"email":"[email protected]","roles":"base-editor"}'
scripts/nocodb.sh base:members:update pdef5678uvw '{"email":"[email protected]","roles":"base-viewer"}'
scripts/nocodb.sh base:members:remove pdef5678uvw '{"email":"[email protected]"}'

テーブル

scripts/nocodb.sh table:list pdef5678uvw                 # → mghi9012rst
scripts/nocodb.sh table:get pdef5678uvw mghi9012rst
scripts/nocodb.sh table:create pdef5678uvw '{"title":"NewTable"}'
scripts/nocodb.sh table:update pdef5678uvw mghi9012rst '{"title":"Customers"}'
scripts/nocodb.sh table:delete pdef5678uvw mghi9012rst

フィールド

scripts/nocodb.sh field:list pdef5678uvw mghi9012rst     # → cjkl3456opq
scripts/nocodb.sh field:get pdef5678uvw mghi9012rst cjkl3456opq
scripts/nocodb.sh field:create pdef5678uvw mghi9012rst '{"title":"Phone","type":"PhoneNumber"}'
scripts/nocodb.sh field:update pdef5678uvw mghi9012rst cjkl3456opq '{"title":"Mobile"}'
scripts/nocodb.sh field:delete pdef5678uvw mghi9012rst cjkl3456opq

フィールドの種類：SingleLineText、LongText、Number、Decimal、Currency、Percent、Email、URL、PhoneNumber、Date、DateTime、Time、SingleSelect、MultiSelect、Checkbox、Rating、Attachment、Links、User、JSON など。

ビュー

注： View API は、セルフホスト型およびクラウドホスト型の Enterprise プランでのみ利用できます。

scripts/nocodb.sh view:list pdef5678uvw mghi9012rst      # → vwmno7890abc
scripts/nocodb.sh view:get pdef5678uvw mghi9012rst vwmno7890abc
scripts/nocodb.sh view:create pdef5678uvw mghi9012rst '{"title":"Active Users","type":"grid"}'
scripts/nocodb.sh view:update pdef5678uvw mghi9012rst vwmno7890abc '{"title":"Renamed"}'
scripts/nocodb.sh view:delete pdef5678uvw mghi9012rst vwmno7890abc

ビューの種類：grid、gallery、kanban、calendar

レコード

scripts/nocodb.sh record:list pdef5678uvw mghi9012rst                # page 1, 25 records
scripts/nocodb.sh record:list pdef5678uvw mghi9012rst 2 50           # page 2, 50 records
scripts/nocodb.sh record:list pdef5678uvw mghi9012rst 1 25 "(status,eq,active)"
scripts/nocodb.sh record:list pdef5678uvw mghi9012rst 1 25 "" '[{"field":"cjkl3456opq","direction":"desc"}]'

scripts/nocodb.sh record:get pdef5678uvw mghi9012rst 31
scripts/nocodb.sh record:get pdef5678uvw mghi9012rst 31 "name,email"

scripts/nocodb.sh record:create pdef5678uvw mghi9012rst '{"fields":{"name":"Alice"}}'
scripts/nocodb.sh record:update pdef5678uvw mghi9012rst 31 '{"status":"active"}'
scripts/nocodb.sh record:update-many pdef5678uvw mghi9012rst '[{"id":31,"fields":{"status":"done"}}]'

scripts/nocodb.sh record:delete pdef5678uvw mghi9012rst 31
scripts/nocodb.sh record:delete pdef5678uvw mghi9012rst '[31,32]'

scripts/nocodb.sh record:count pdef5678uvw mghi9012rst
scripts/nocodb.sh record:count pdef5678uvw mghi9012rst "(status,eq,active)"

リンクされたレコード

scripts/nocodb.sh link:list pdef5678uvw mghi9012rst cjkl3456opq 31
scripts/nocodb.sh link:add pdef5678uvw mghi9012rst cjkl3456opq 31 '[{"id":42}]'
scripts/nocodb.sh link:remove pdef5678uvw mghi9012rst cjkl3456opq 31 '[{"id":42}]'

フィルターとソート（ビュー単位）

scripts/nocodb.sh filter:list pdef5678uvw mghi9012rst vwmno7890abc
scripts/nocodb.sh filter:create pdef5678uvw mghi9012rst vwmno7890abc '{"field_id":"cjkl3456opq","operator":"eq","value":"active"}'
scripts/nocodb.sh sort:list pdef5678uvw mghi9012rst vwmno7890abc
scripts/nocodb.sh sort:create pdef5678uvw mghi9012rst vwmno7890abc '{"field_id":"cjkl3456opq","direction":"desc"}'

添付ファイル

scripts/nocodb.sh attachment:upload pdef5678uvw mghi9012rst 31 cjkl3456opq ./report.pdf

スクリプト

注： Script API は、セルフホスト型およびクラウドホスト型の Enterprise プランでのみ利用できます。

scripts/nocodb.sh script:list pdef5678uvw
scripts/nocodb.sh script:create pdef5678uvw '{"title":"My Script"}'

チーム

注： Team API には Enterprise プランが必要です（ワークスペースチームは Enterprise のみ）。

scripts/nocodb.sh team:list wabc1234xyz
scripts/nocodb.sh team:create wabc1234xyz '{"title":"Engineering"}'

API トークン

注： API Token API は、セルフホスト型 Enterprise プランおよびクラウドホスト型 Enterprise プランでのみ利用できます。

scripts/nocodb.sh token:list
scripts/nocodb.sh token:create '{"title":"CI Token"}'
scripts/nocodb.sh token:delete tkn1a2b3c4d5e6f7g

Where フィルター構文

すべてのドキュメントは scripts/nocodb.sh where:help を実行して確認してください。

基本構文

(field,operator,value)
(field,operator)                    # for null/blank/checked operators
(field,operator,sub_op)             # for date operators
(field,operator,sub_op,value)       # for date with value

よく使う演算子

演算子	説明	例
eq	等しい	(name,eq,John)
neq	等しくない	(status,neq,archived)
like	含む（% ワイルドカード）	(name,like,%john%)
in	リスト内にある	(status,in,active,pending)
gt, lt, gte, lte	数値の比較	(price,gt,100)
blank, notblank	NULL または空	(notes,blank)
checked, notchecked	ブール値	(is_active,checked)

日付演算子

(created_at,eq,today)
(created_at,isWithin,pastWeek)
(created_at,isWithin,pastNumberOfDays,14)
(due_date,lt,today)                          # overdue
(event_date,eq,exactDate,2024-06-15)

フィルターの結合

重要： ~and、~or、~not（チルダを接頭辞として付ける）を使用します。

(name,eq,John)~and(age,gte,18)
(status,eq,active)~or(status,eq,pending)
~not(is_deleted,checked)
(status,in,active,pending)~and(country,eq,USA)

複雑な例

# Active users created this month
"(status,eq,active)~and(created_at,isWithin,pastMonth)"

# Overdue high-priority tasks
"(due_date,lt,today)~and(priority,eq,high)~and(completed,notchecked)"

# Orders $100-$500 in pending/processing
"(amount,gte,100)~and(amount,lte,500)~and(status,in,pending,processing)"