Skip to main content

Command Glossary

Use this page when you need to choose the right command family.

Rule Of Thumb​

NeedUse
Configure how this repository connects to n8nn8nac env
Inspect workspace snapshotsn8nac workspace
Create, start, stop, or tunnel a local managed instancen8n-manager

Primary Usage​

n8nac env manages workspace environments.

n8nac env list
n8nac env status
n8nac env add <name> --base-url <url> --workflows-path <path>
n8nac env add <name> --managed-instance <id> --workflows-path <path>
n8nac env use <environment>
n8nac env auth set <environment> --api-key-stdin
n8nac env auth clear <environment>
n8nac env remove <environment>

Use it for:

  • remote n8n URLs
  • local API-key binding for remote environments
  • managed local instance references
  • project and workflowsPath context
  • active environment selection

Workspace Maintenance​

n8nac workspace inspects the V4 workspace snapshot. Use env status for effective runtime readiness.

n8nac workspace status --json
n8nac env status --json

Managed Local Instances​

n8n-manager manages local machine resources.

n8n-manager instance list
n8n-manager instance create
n8n-manager instance start <id>
n8n-manager instance stop <id>
n8n-manager instance remove <id>
n8n-manager tunnel start <id>
n8n-manager tunnel stop <id>

Use it only for local managed instances, Docker lifecycle, and tunnels. Do not use it as the repository source of truth.

Workflow Sync​

After an environment exists, normal workflow operations stay in n8nac:

n8nac list
n8nac pull <workflow-id>
n8nac push <path-to-workflow.workflow.ts> --verify
n8nac promote <path-to-workflow.workflow.ts> --from Dev --to Prod
n8nac promote --from Dev --to Prod --dry-run
n8nac resolve <workflow-id> --mode keep-current
n8nac resolve <workflow-id> --mode keep-incoming

Use promote to move workflow source between workspace environments. The path is optional: pass one workflow file for a targeted promotion, or omit it to recursively promote every *.workflow.ts file in the source environment workflowsPath. Promotion remaps target project metadata, credentials, and supported Execute Workflow references, saves stable bindings in n8nac-promotion.json, and pushes by default unless --no-push is used.

AI Context And Skills​

n8nac update-ai
n8nac skills search "google sheets"
n8nac skills node-info googleSheets
n8nac skills validate workflows/dev/my-workflow.workflow.ts

Prefer n8nac env for all workspace configuration.