@nc-blocks/cli

ncblock — the command line tool for building NocoDB Blocks. Scaffold a block, develop it with live reload, and ship it to your NocoDB deployment.

Install

npm install -g @nc-blocks/cli

# or run without installing
npx @nc-blocks/cli --help

Quick start

You'll need a NocoDB API token (Account → API Tokens).

# 1. Save your token for the deployment
ncblock set-token --host https://your-nocodb.com

# 2. Create a block, then scaffold a project for it
ncblock create "My Block" --host https://your-nocodb.com
ncblock init <blockId> --host https://your-nocodb.com

# 3. Develop with live reload
cd <blockId>
ncblock run

# 4. Ship it, then install into a base
ncblock release
ncblock install --base-id <baseId>

Commands

| Command | What it does | | ----------- | ------------------------------ | | set-token | Save your API token for a host | | create | Create a new block | | init | Scaffold a project for a block | | run | Run locally with live reload | | release | Publish a new version | | install | Install a block into a base |

Run ncblock <command> --help for the available options.

Blocks are built with @nc-blocks/core.

License

MIT