Nimbu Developer Docs
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

NameRequiredDescription
assignmentsnoInline assignments (e.g. name=main.js, code=console.log(1))

Flags

FlagRequiredDefaultDescription
--appyesApplication ID
--filenoRead code file JSON from file (use - for stdin)

nimbu apps code delete

Delete an app code file (requires --force)

Flags

FlagRequiredDefaultDescription
--appyesApplication ID
--filenameyesCode filename

nimbu apps code get

Get an app code file

Flags

FlagRequiredDefaultDescription
--appyesApplication ID
--filenameyesCode filename

nimbu apps code list

List app code files

Flags

FlagRequiredDefaultDescription
--fieldsnoComma-separated fields to return
--localenoFilter by locale
--includenoInclude related resources
--sortnoSort by field, e.g. field or field:desc
--filtersnoFilter by key=value, repeatable
--appyesApplication ID

nimbu apps code pull

Pull remote app code files

Flags

FlagRequiredDefaultDescription
--appnoConfigured local app name
--onlynoRemote or project-relative file subset; commas split multiple files

nimbu apps code update

Update an app code file

Arguments

NameRequiredDescription
assignmentsnoInline assignments such as code=...

Flags

FlagRequiredDefaultDescription
--appyesApplication ID
--filenameyesCode filename
--filenoRead JSON from file (use - for stdin)

nimbu apps config

Add an app to local project config

nimbu apps create

Create an app

Flags

FlagRequiredDefaultDescription
--nameyesApp name
--descriptionnoApp description
--internalnotrueCreate an internal app (callback derived from scopes). Use --no-internal for an external app.
--scopesnoInstall scopes (comma-separated, e.g. read_channels,write_channels); required for internal apps
--urlnoApp URL (external apps only)
--callback-urlnoOAuth callback URL (external apps only)
--sdk-versionnoCloud-code SDK version
--installnoGrant and register the app on the site in one step (default: true for internal apps)
--configurenoAfter creating, add the app to the local nimbu.yml project config

nimbu apps get

Get app details

Flags

FlagRequiredDefaultDescription
--appyesApplication ID

nimbu apps list

List apps

Flags

FlagRequiredDefaultDescription
--fieldsnoComma-separated fields to return
--localenoFilter by locale
--includenoInclude related resources
--sortnoSort by field, e.g. field or field:desc
--filtersnoFilter by key=value, repeatable
--allnoFetch all pages
--pageno1Page number
--per-pageno25Items per page

nimbu apps logs

Read app cloud-code logs

Flags

FlagRequiredDefaultDescription
--appyesApplication local name or key
-t, --tailnoPoll for new logs until interrupted
--levelnoMinimum severity: debug, info, warn, error, fatal
-q, --querynoText search query
--jobnoOnly logs from this background job name
--sincenoOnly logs after this value; raw epoch/ISO8601 or duration like 15m, 1h, 24h
--limitno100Maximum logs to fetch

nimbu apps push

Push configured local cloud-code files

Flags

FlagRequiredDefaultDescription
--appnoConfigured local app name
--syncnoDelete remote files missing locally
--onlynoProject-relative file subset; commas split multiple files

nimbu apps update

Update an app

Flags

FlagRequiredDefaultDescription
--appyesApplication ID
--namenoApp name
--descriptionnoApp description
--internalnoWhether the app is internal (callback derived from scopes)
--scopesnoInstall scopes (comma-separated, e.g. read_channels,write_channels)
--urlnoApp URL (external apps only)
--callback-urlnoOAuth callback URL (external apps only)
--sdk-versionnoCloud-code SDK version

On this page