Skip to content

CLI reference

The edge-connector CLI manages authentication, tool code generation, bundle packaging and upload, bundle assignment, and cloud connector lifecycle. Running edge-connector with no arguments opens an interactive menu covering the same operations.

Authenticate the CLI against your nara organization.

Terminal window
edge-connector auth
FlagDescription
-t, --token <token>Provide a JWT directly, or a path to a token file. Must be unexpired and contain org info.
-i, --interactiveInteractive prompt (default).
-b, --browserDevice-code browser flow.

--token and --browser cannot be combined.

Alias: g. Scaffolds TypeScript implementation stubs for your organization’s EDGE tools. Requires authentication; fetches tool definitions from the Tool RPC server.

Terminal window
edge-connector generate -t myTool
FlagDescription
-l, --languageTarget language (typescript only).
-t, --tool <name>Generate a specific tool only.
-o, --output <path>Output directory (default ./custom-implementations).
-i, --interactiveInteractive prompt.

Build and package tool implementations into a bundle archive. Each tool must live in its own file under tools/ — a single index.ts entrypoint is no longer supported. The output is edge-bundle-<orgId>-<timestamp>.tgz containing manifest.json and dist/.

Terminal window
edge-connector package
FlagDescription
-i, --implementations <path>Implementations directory (default ./custom-implementations).
-o, --out <dir>Output directory (default ./artifacts).
--no-buildSkip the build step.

Package (unless -f is given) and upload a bundle to the platform. Maximum bundle size is 50 MB. A successful upload updates currentBundleId.

Terminal window
edge-connector upload
FlagDescription
-f, --file <tgz>Upload an existing bundle archive.
-i, --interactiveInteractive prompt.
--no-buildSkip the build step.
--api <url>Override the platform API URL.
--name <text>Bundle name.
--notes <text>Bundle notes.

Manage tool bundles. All subcommands accept --api <url>.

SubcommandDescription
bundle listList your organization’s bundles.
bundle checkout [id]Check out a bundle locally; --new starts a fresh bundle.
bundle statusShow the currently checked-out bundle.
bundle toolsList tools in the current bundle.
bundle ref <tool> --version <n>Reference a server-hosted tool version instead of local source.
bundle set-default <id>Set the organization’s default bundle.
bundle assign <id> --deployment <id> [--version <n>]Assign a bundle to a deployment, optionally pinned to a version.
bundle rename <id> <name>Rename a bundle.

Manage your organization’s cloud connector (via /api/edge/cloud/*).

SubcommandDescription
cloud provision --env <dev|stage|prod>Provision a cloud connector.
cloud startStart the cloud connector.
cloud stopStop the cloud connector.
cloud statusShow connector status.
cloud force-completeForce a pending operation to complete.
cloud deleteDelete the cloud connector.