CLICommand reference
Apps
Generated reference for nimbu apps
Generated from the CLI command contract. Do not edit this page manually.
nimbu apps
Manage OAuth apps
nimbu apps code
Manage app cloud code files
nimbu apps code create
Create app code file from JSON
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. name=main.js, code=console.log(1)) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID | |
--file | no | Read code file JSON from file (use - for stdin) |
nimbu apps code delete
Delete an app code file (requires --force)
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID | |
--filename | yes | Code filename |
nimbu apps code get
Get an app code file
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID | |
--filename | yes | Code filename |
nimbu apps code list
List app code files
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Filter by locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--app | yes | Application ID |
nimbu apps code pull
Pull remote app code files
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | no | Configured local app name | |
--only | no | Remote or project-relative file subset; commas split multiple files |
nimbu apps code update
Update an app code file
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments such as code=... |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID | |
--filename | yes | Code filename | |
--file | no | Read JSON from file (use - for stdin) |
nimbu apps config
Add an app to local project config
nimbu apps create
Create an app
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--name | yes | App name | |
--description | no | App description | |
--internal | no | true | Create an internal app (callback derived from scopes). Use --no-internal for an external app. |
--scopes | no | Install scopes (comma-separated, e.g. read_channels,write_channels); required for internal apps | |
--url | no | App URL (external apps only) | |
--callback-url | no | OAuth callback URL (external apps only) | |
--sdk-version | no | Cloud-code SDK version | |
--install | no | Grant and register the app on the site in one step (default: true for internal apps) | |
--configure | no | After creating, add the app to the local nimbu.yml project config |
nimbu apps get
Get app details
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID |
nimbu apps list
List apps
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Filter by locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--all | no | Fetch all pages | |
--page | no | 1 | Page number |
--per-page | no | 25 | Items per page |
nimbu apps logs
Read app cloud-code logs
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application local name or key | |
-t, --tail | no | Poll for new logs until interrupted | |
--level | no | Minimum severity: debug, info, warn, error, fatal | |
-q, --query | no | Text search query | |
--job | no | Only logs from this background job name | |
--since | no | Only logs after this value; raw epoch/ISO8601 or duration like 15m, 1h, 24h | |
--limit | no | 100 | Maximum logs to fetch |
nimbu apps push
Push configured local cloud-code files
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | no | Configured local app name | |
--sync | no | Delete remote files missing locally | |
--only | no | Project-relative file subset; commas split multiple files |
nimbu apps update
Update an app
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--app | yes | Application ID | |
--name | no | App name | |
--description | no | App description | |
--internal | no | Whether the app is internal (callback derived from scopes) | |
--scopes | no | Install scopes (comma-separated, e.g. read_channels,write_channels) | |
--url | no | App URL (external apps only) | |
--callback-url | no | OAuth callback URL (external apps only) | |
--sdk-version | no | Cloud-code SDK version |