{ "name": "northflank", "description": "Manage your Northflank resources from the command line", "options": [ { "names": [ "-v", "--version" ], "description": "Print the current version of the Northflank cli" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "forward", "aliases": [ "fwd" ], "description": "Port-forwarding for Northflank services and addons", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "all", "description": "Port-forwarding for all services and addons in the given project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for forwarding", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "--skipHostnames" ], "description": "Only expose on IP address, not on hostnames. With this option, no root permissions are required" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "description": "Port-forwarding for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for forwarding", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to forward", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "--skipHostnames" ], "description": "Only expose on IP address, not on hostnames. With this option, no root permissions are required" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "addon", "description": "Port-forwarding for the specified addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for forwarding", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--addon", "--addonId" ], "description": "Addon to forward", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--skipHostnames" ], "description": "Only expose on IP address, not on hostnames. With this option, no root permissions are required" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "command-exec", "aliases": [ "exec" ], "description": "Command execution (exec) for Northflank services and jobs", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "service", "description": "Command exec for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for exec", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to exec into", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (random container will be chosen if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--shell-cmd" ], "description": "Run command with shell (e.g. bash,sh). If not set and no command is provided, several standard shells will be attempted. If not set and a command is provided, the command will run without shell", "args": [ { "name": "SHELL-CMD", "isOptional": true } ] }, { "names": [ "--user" ], "description": "Run command with this user", "args": [ { "name": "USER", "isOptional": true } ] }, { "names": [ "--group" ], "description": "Run command with this group", "args": [ { "name": "GROUP", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "--cmd", "--command" ], "description": "Command to execute, if --shell option is present, it will run in the specified shell, otherwise", "args": [ { "name": "COMMAND", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "description": "Command exec for the specified job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for exec", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--job", "--jobId" ], "description": "Job to exec into", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (random container will be chosen if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--shell-cmd" ], "description": "Run command with shell (e.g. bash,sh). If not set and no command is provided, several standard shells will be attempted. If not set and a command is provided, the command will run without shell", "args": [ { "name": "SHELL-CMD", "isOptional": true } ] }, { "names": [ "--user" ], "description": "Run command with this user", "args": [ { "name": "USER", "isOptional": true } ] }, { "names": [ "--group" ], "description": "Run command with this group", "args": [ { "name": "GROUP", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "--cmd", "--command" ], "description": "Command to execute, if --shell option is present, it will run in the specified shell, otherwise", "args": [ { "name": "COMMAND", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "login", "description": "Connect the CLI to your Northflank account", "options": [ { "names": [ "--token-login" ], "description": "Use manual login with API token" }, { "names": [ "--do-not-open-browser" ], "description": "Use browser login but only print URL which can be used to login" }, { "names": [ "-n", "--name" ], "description": "Name for login context", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "-t", "--token" ], "description": "Token for this context. When set, browser login is not used", "args": [ { "name": "TOKEN", "isOptional": true } ] }, { "names": [ "--host" ], "description": "Host url for this context", "args": [ { "name": "HOST", "isOptional": true } ] }, { "names": [ "--override" ], "description": "Override existing contexts (this will remove project and service context)" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "context", "aliases": [ "contexts", "ctx" ], "description": "Retrieve and update local context settings", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "ls", "description": "List all available contexts", "options": [ { "names": [ "--all" ], "description": "Shows full context information (including tokens)" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "use", "description": "Switch between your local contexts", "options": [ { "names": [ "-n", "--name" ], "description": "Change current context to context identified by this name", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "project", "description": "Change the default project in the current local context", "options": [ { "names": [ "-i", "--id" ], "description": "Project name (internal id) to use as default in context", "args": [ { "name": "ID", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "description": "Change the default job in the current local context", "options": [ { "names": [ "-i", "--id" ], "description": "Job name (internal id) to use as default in context", "args": [ { "name": "ID", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "description": "Change the default service in the current local context", "options": [ { "names": [ "-i", "--id" ], "description": "Service name (internal id) to use as default in context", "args": [ { "name": "ID", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "remove", "aliases": [ "delete", "rm" ], "description": "Remove a context", "options": [ { "names": [ "-i", "--id" ], "description": "Local context name to remove", "args": [ { "name": "ID", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "update-token", "aliases": [ "set-token" ], "description": "Update token for current context", "options": [ { "names": [ "-t", "--token" ], "description": "Token for this context", "args": [ { "name": "TOKEN", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "list", "description": "List Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "projects", "aliases": [ "project", "prj" ], "description": "Lists projects for the authenticated user or team", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "addons", "aliases": [ "addon", "adn" ], "description": "Gets a list of addons belonging to the project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "invoices", "aliases": [ "invoice", "inv" ], "description": "Get a list of past invoices", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "providers", "description": "Lists supported cloud providers", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "integrations", "description": "Lists integrations for the authenticated user or team", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "clusters", "description": "Lists clusters for the authenticated user or team", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "jobs", "aliases": [ "job" ], "description": "Gets a list of jobs belonging to the project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "log-sinks", "description": "Gets a list of log sinks added to this account", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "registries", "description": "Lists the container registry credentials saved to this account. Does not display secrets", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "domains", "aliases": [ "domain", "dmn" ], "description": "Lists available domains", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "plans", "aliases": [ "plan", "pln" ], "description": "Lists available billing plans", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "regions", "aliases": [ "region", "rgn" ], "description": "Lists available project regions", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "vcs", "description": "Lists linked version control providers", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "pipelines", "description": "Lists all pipelines for a project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "release-flow-runs", "description": "Lists runs of a release flow", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secrets", "aliases": [ "secret", "scrt" ], "description": "Gets a list of secrets belonging to the project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "services", "aliases": [ "service", "svc" ], "description": "Gets a list of services belonging to the project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "templates", "aliases": [ "template", "tpl" ], "description": "Get a list of templates", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "template-runs", "description": "Get a list of template runs", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "repos", "aliases": [ "repository", "repositories", "repo" ], "description": "Gets a list of repositories accessible to this account", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--vcs_service" ], "description": "OPTIONAL: If provided, only returns repositories belonging to this version control provider., example: github", "args": [ { "name": "VCS_SERVICE" } ] }, { "names": [ "--self_hosted_vcs_id" ], "description": "OPTIONAL: If provided, only returns repositories belonging to this self-hosted version control provider", "args": [ { "name": "SELF_HOSTED_VCS_ID" } ] }, { "names": [ "--account_login" ], "description": "OPTIONAL: If provided, only returns repositories that can be accessed by the linked version control account with this name., example: example-user", "args": [ { "name": "ACCOUNT_LOGIN" } ] }, { "names": [ "--vcs_link_id" ], "description": "OPTIONAL: If provided, only returns repositories belong to that VCS link", "args": [ { "name": "VCS_LINK_ID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "branches", "aliases": [ "branch", "brn" ], "description": "Gets a list of branches for the repo", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--repositoryName" ], "description": "Name of the repository, example: next-js-example", "args": [ { "name": "REPOSITORYNAME" } ] }, { "names": [ "--repositoryOwner" ], "description": "Name of the owner of the repository, example: northflank-examples", "args": [ { "name": "REPOSITORYOWNER" } ] }, { "names": [ "--vcsService" ], "description": "Version control provider of the repository, example: github", "args": [ { "name": "VCSSERVICE" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "volumes", "aliases": [ "volume", "vol" ], "description": "Gets a list of volumes belonging to the project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml|custom-columns=,,...'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "create", "description": "Create Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "project", "aliases": [ "projects", "prj" ], "description": "Creates a new project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Creates a new addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup-schedule", "description": "Create a new backup schedule for an addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "integration", "description": "Creates a new integration", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "cluster", "description": "Creates a new cluster", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Job Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "manual", "description": "Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "cron", "description": "Creates a new cron job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "log-sink", "description": "Creates a new log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "domain", "aliases": [ "domains", "dmn" ], "description": "Registers a new domain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret", "aliases": [ "secrets", "scrt" ], "description": "Creates a secret with the specified payload", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Service Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "combined", "description": "Creates a new combined service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "deployment", "description": "Creates a new deployment service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build", "description": "Creates a new build service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "custom-vcs", "description": "CustomVcs Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "token", "description": "Generate a token for a specific VCS link", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--vcsLink", "--vcsLinkId" ], "description": "ID of the version control link, example: 63ebb6ce2ccc6c7affdbf253", "args": [ { "name": "VCSLINKID" } ] }, { "names": [ "--customVCS", "--customVCSId" ], "description": "ID of the custom VCS, example: cdb3d41f-0dd8-49ad-92d5-7544c98c490b", "args": [ { "name": "CUSTOMVCSID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Creates a volume with the specified payload", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "get", "description": "Get information about Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "project", "aliases": [ "projects", "prj" ], "description": "Get information about the given project", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Gets information about the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "credentials", "aliases": [ "credential", "cred" ], "description": "Returns the credentials for connecting to the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "logs", "aliases": [ "log" ], "description": "Get log for the specified addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "projectId", "isOptional": true } ] }, { "names": [ "--addon", "--addonId" ], "description": "Addon to get logs from", "args": [ { "name": "addonId", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "containerId", "isOptional": true } ] }, { "names": [ "-f", "--tail" ], "description": "Tail will stream logs in real-time. Session will be kept open" }, { "names": [ "-l", "--lineLimit" ], "description": "Number of lines to return", "args": [ { "name": "limit", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get logs generated after this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get logs generated before this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-d", "--direction" ], "description": "Direction of logs. Ignored when tailing", "args": [ { "name": "order", "suggestions": [ "backward", "forward" ] } ] }, { "names": [ "--textIncludes" ], "description": "Filter log lines to include this text", "args": [ { "name": "text" } ] }, { "names": [ "--textNotIncludes" ], "description": "Filter log lines to not include this text", "args": [ { "name": "text" } ] }, { "names": [ "--regexIncludes" ], "description": "Filter log lines to match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--regexNotIncludes" ], "description": "Filter log lines to not match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "metrics", "aliases": [ "metric" ], "description": "Get metrics for the specified addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--addon", "--addonId" ], "description": "Addon to get logs from", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get metrics after this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get metrics before this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-t", "--metricTypes" ], "description": "Which metric type to fetch", "args": [ { "name": "metricTypes", "isVariadic": true, "suggestions": [ "cpu", "memory", "networkIngress", "networkEgress", "tcpConnectionsOpen", "diskUsage", "requests", "http4xxResponses", "http5xxResponses" ] } ] }, { "names": [ "--timestamp" ], "description": "Get metrics at this exact timestamp, if no timestamp set most recent time is used. example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "types", "description": "Gets information about the available addon types", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "version", "description": "Gets details about the current addon version including available upgrades and upgrade history", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "backups", "description": "Returns a list of backups for the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "backup", "description": "Gets details about a given backup", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "download", "description": "Generates a temporary download link for downloading the given backup", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "restores", "description": "Gets a list of restores for the given backup", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "containers", "description": "Gets a list of containers for the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "backup-schedules", "description": "Gets details about an addon's backup schedules", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "pitr-window", "description": "Gets the valid window for performing a point-in-time restore (PITR) on this addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "invoice", "aliases": [ "invoices", "inv" ], "description": "Get information about Northflank invoices", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "details", "description": "Get details about an invoice. If `timestamp` is passed in as a query parameter, this endpoint returns details about the invoice containing that timestamp. Otherwise, returns a preview invoice displaying billing data from after the most recent invoice", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--timestamp" ], "description": "OPTIONAL: Timestamp of an invoice. If passed in, this endpoint will return details about the invoice that time belongs to., example: 1657206215", "args": [ { "name": "TIMESTAMP" } ] }, { "names": [ "--projectId" ], "description": "OPTIONAL: ID of a project. If passed in, only details about that project will be returned., example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--addonId" ], "description": "OPTIONAL: ID of a addon. If passed in, only details about that addon will be returned", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--serviceId" ], "description": "OPTIONAL: ID of a service. If passed in, only details about that service will be returned., example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--jobId" ], "description": "OPTIONAL: ID of a job. If passed in, only details about that job will be returned", "args": [ { "name": "JOBID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "integration", "description": "Get information about the given integration", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--integration", "--integrationId" ], "description": "ID of the provider integration, example: gcp-integration-1", "args": [ { "name": "INTEGRATIONID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "cluster", "description": "Get information about the given cluster", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--cluster", "--clusterId" ], "description": "ID of the cluster, example: gcp-cluster-1", "args": [ { "name": "CLUSTERID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Gets information about the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "runs", "description": "Fetches run history for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "logs", "aliases": [ "log" ], "description": "Get log for the specified job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "projectId", "isOptional": true } ] }, { "names": [ "--job", "--jobId" ], "description": "Job to get logs from", "args": [ { "name": "jobId", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "containerId", "isOptional": true } ] }, { "names": [ "-f", "--tail" ], "description": "Tail will stream logs in real-time. Session will be kept open" }, { "names": [ "-l", "--lineLimit" ], "description": "Number of lines to return", "args": [ { "name": "limit", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get logs generated after this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get logs generated before this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-d", "--direction" ], "description": "Direction of logs. Ignored when tailing", "args": [ { "name": "order", "suggestions": [ "backward", "forward" ] } ] }, { "names": [ "--textIncludes" ], "description": "Filter log lines to include this text", "args": [ { "name": "text" } ] }, { "names": [ "--textNotIncludes" ], "description": "Filter log lines to not include this text", "args": [ { "name": "text" } ] }, { "names": [ "--regexIncludes" ], "description": "Filter log lines to match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--regexNotIncludes" ], "description": "Filter log lines to not match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--run", "--runId" ], "description": "Job run id, example: 162b1977-6636-4000-929b-cc265b862ff0", "args": [ { "name": "runId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "metrics", "aliases": [ "metric" ], "description": "Get metrics for the specified job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--job", "--jobId" ], "description": "Job to get logs from", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get metrics after this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get metrics before this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-t", "--metricTypes" ], "description": "Which metric type to fetch", "args": [ { "name": "metricTypes", "isVariadic": true, "suggestions": [ "cpu", "memory", "networkIngress", "networkEgress", "tcpConnectionsOpen", "diskUsage", "requests", "http4xxResponses", "http5xxResponses" ] } ] }, { "names": [ "--timestamp" ], "description": "Get metrics at this exact timestamp, if no timestamp set most recent time is used. example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--run", "--runId" ], "description": "Job run id, example: 162b1977-6636-4000-929b-cc265b862ff0", "args": [ { "name": "runId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-logs", "aliases": [ "build-log" ], "description": "Get log for the specified job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "projectId", "isOptional": true } ] }, { "names": [ "--job", "--jobId" ], "description": "Job to get logs from", "args": [ { "name": "jobId", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "containerId", "isOptional": true } ] }, { "names": [ "-f", "--tail" ], "description": "Tail will stream logs in real-time. Session will be kept open" }, { "names": [ "-l", "--lineLimit" ], "description": "Number of lines to return", "args": [ { "name": "limit", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get logs generated after this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get logs generated before this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-d", "--direction" ], "description": "Direction of logs. Ignored when tailing", "args": [ { "name": "order", "suggestions": [ "backward", "forward" ] } ] }, { "names": [ "--textIncludes" ], "description": "Filter log lines to include this text", "args": [ { "name": "text" } ] }, { "names": [ "--textNotIncludes" ], "description": "Filter log lines to not include this text", "args": [ { "name": "text" } ] }, { "names": [ "--regexIncludes" ], "description": "Filter log lines to match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--regexNotIncludes" ], "description": "Filter log lines to not match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--build", "--buildId" ], "description": "Build to get logs from", "args": [ { "name": "buildId", "isOptional": true } ] }, { "names": [ "--run", "--runId" ], "description": "Job run id, example: 162b1977-6636-4000-929b-cc265b862ff0", "args": [ { "name": "runId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-metrics", "aliases": [ "build-metric" ], "description": "Get metrics for the specified job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--job", "--jobId" ], "description": "Job to get logs from", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get metrics after this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get metrics before this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-t", "--metricTypes" ], "description": "Which metric type to fetch", "args": [ { "name": "metricTypes", "isVariadic": true, "suggestions": [ "cpu", "memory", "networkIngress", "networkEgress", "tcpConnectionsOpen", "diskUsage", "requests", "http4xxResponses", "http5xxResponses" ] } ] }, { "names": [ "--timestamp" ], "description": "Get metrics at this exact timestamp, if no timestamp set most recent time is used. example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--build", "--buildId" ], "description": "Build to get logs from", "args": [ { "name": "buildId", "isOptional": true } ] }, { "names": [ "--run", "--runId" ], "description": "Job run id, example: 162b1977-6636-4000-929b-cc265b862ff0", "args": [ { "name": "runId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "run", "description": "Returns data about the given job run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--run", "--runId" ], "description": "ID of the job run, example: d34582a4-35bd-4c71-8e7c-e36999b88723", "args": [ { "name": "RUNID" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "health-checks", "description": "Lists the health checks for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "builds", "description": "Lists builds for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build", "description": "Gets information about a build for the job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--build", "--buildId" ], "description": "ID of the job build, example: joyous-view-6290", "args": [ { "name": "BUILDID" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-arguments", "description": "Gets the build arguments of the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--show" ], "description": "OPTIONAL: Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed., example: all", "args": [ { "name": "SHOW" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-argument-details", "description": "Get details about the build arguments accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment", "description": "Returns the runtime environment for the given job. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--show" ], "description": "OPTIONAL: Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed., example: all", "args": [ { "name": "SHOW" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment-details", "description": "Get details about the runtime environment accessible by the given job. Also requires the permission 'Project > Secrets > General > Read'", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "deployment", "description": "Gets information about the deployment of the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "containers", "description": "Gets a list of containers for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "branches", "aliases": [ "branch", "brn" ], "description": "Gets information about the branches of the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "pull-requests", "description": "Gets information about the pull-requests of the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "log-sink", "description": "Gets details about a given log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--logSink", "--logSinkId" ], "description": "ID of the log sink, example: example-log-sink", "args": [ { "name": "LOGSINKID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "registry", "description": "Views a set of registry credential data", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--credential", "--credentialId" ], "description": "ID of the registry credential, example: example-credentials", "args": [ { "name": "CREDENTIALID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "domain", "aliases": [ "domains", "dmn" ], "description": "Gets details about domain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "subdomain", "description": "Gets details about the given subdomain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--subdomain" ], "description": "Name of the subdomain, example: app", "args": [ { "name": "SUBDOMAIN" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "dns-id", "description": "Returns the partially random string used when generating host names for the authenticated account", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "pipeline", "description": "Get details about a pipeline", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "release-flow", "description": "Gets details about a release flow", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "release-flow-run", "description": "Get information about the given release flow run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--run", "--runId" ], "description": "ID of the release flow run, example: development", "args": [ { "name": "RUNID" } ] }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret", "aliases": [ "secrets", "scrt" ], "description": "View a secret including its contents", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--show" ], "description": "OPTIONAL: Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed., example: all", "args": [ { "name": "SHOW" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret-details", "description": "View a secret with details about its linked addons", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret-link", "description": "Get details about a given addon link", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Gets information about the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "deployment", "description": "Gets information about the deployment of the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "logs", "aliases": [ "log" ], "description": "Get log for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "projectId", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to get logs from", "args": [ { "name": "serviceId", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "containerId", "isOptional": true } ] }, { "names": [ "-f", "--tail" ], "description": "Tail will stream logs in real-time. Session will be kept open" }, { "names": [ "-l", "--lineLimit" ], "description": "Number of lines to return", "args": [ { "name": "limit", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get logs generated after this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get logs generated before this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-d", "--direction" ], "description": "Direction of logs. Ignored when tailing", "args": [ { "name": "order", "suggestions": [ "backward", "forward" ] } ] }, { "names": [ "--textIncludes" ], "description": "Filter log lines to include this text", "args": [ { "name": "text" } ] }, { "names": [ "--textNotIncludes" ], "description": "Filter log lines to not include this text", "args": [ { "name": "text" } ] }, { "names": [ "--regexIncludes" ], "description": "Filter log lines to match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--regexNotIncludes" ], "description": "Filter log lines to not match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "metrics", "aliases": [ "metric" ], "description": "Get metrics for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to get logs from", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get metrics after this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get metrics before this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-t", "--metricTypes" ], "description": "Which metric type to fetch", "args": [ { "name": "metricTypes", "isVariadic": true, "suggestions": [ "cpu", "memory", "networkIngress", "networkEgress", "tcpConnectionsOpen", "diskUsage", "requests", "http4xxResponses", "http5xxResponses" ] } ] }, { "names": [ "--timestamp" ], "description": "Get metrics at this exact timestamp, if no timestamp set most recent time is used. example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-logs", "aliases": [ "build-log" ], "description": "Get log for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "projectId", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to get logs from", "args": [ { "name": "serviceId", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "containerId", "isOptional": true } ] }, { "names": [ "-f", "--tail" ], "description": "Tail will stream logs in real-time. Session will be kept open" }, { "names": [ "-l", "--lineLimit" ], "description": "Number of lines to return", "args": [ { "name": "limit", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get logs generated after this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get logs generated before this time, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-d", "--direction" ], "description": "Direction of logs. Ignored when tailing", "args": [ { "name": "order", "suggestions": [ "backward", "forward" ] } ] }, { "names": [ "--textIncludes" ], "description": "Filter log lines to include this text", "args": [ { "name": "text" } ] }, { "names": [ "--textNotIncludes" ], "description": "Filter log lines to not include this text", "args": [ { "name": "text" } ] }, { "names": [ "--regexIncludes" ], "description": "Filter log lines to match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--regexNotIncludes" ], "description": "Filter log lines to not match this regular expression", "args": [ { "name": "regex" } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--build", "--buildId" ], "description": "Build to get logs from", "args": [ { "name": "buildId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-metrics", "aliases": [ "build-metric" ], "description": "Get metrics for the specified service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "Project for logs", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--service", "--serviceId" ], "description": "Service to get logs from", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--container", "--containerId" ], "description": "Container to exec into (logs from all containers will be shown if not specified)", "args": [ { "name": "NAME", "isOptional": true } ] }, { "names": [ "--startTime" ], "description": "Get metrics after this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--endTime" ], "description": "Get metrics before this timestamp, example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp" } ] }, { "names": [ "--duration" ], "description": "Length of timespan in seconds. Only valid if not both, startTime and endTime are set", "args": [ { "name": "duration", "isOptional": true } ] }, { "names": [ "-t", "--metricTypes" ], "description": "Which metric type to fetch", "args": [ { "name": "metricTypes", "isVariadic": true, "suggestions": [ "cpu", "memory", "networkIngress", "networkEgress", "tcpConnectionsOpen", "diskUsage", "requests", "http4xxResponses", "http5xxResponses" ] } ] }, { "names": [ "--timestamp" ], "description": "Get metrics at this exact timestamp, if no timestamp set most recent time is used. example: 2020-02-02T02:02:02Z (date string) or 1580608922 (unix ts)", "args": [ { "name": "timestamp", "isOptional": true } ] }, { "names": [ "--noDefaults" ], "description": "Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "Output formatting. Will use advanced formatting by default", "args": [ { "name": "output", "isOptional": true, "suggestions": [ "format", "json", "yaml" ] } ] }, { "names": [ "--build", "--buildId" ], "description": "Build to get logs from", "args": [ { "name": "buildId", "isOptional": true } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "ports", "description": "Lists the ports for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "health-checks", "description": "Lists the health checks for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "builds", "description": "Lists the builds for the service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build", "description": "Gets information about a build for the service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--build", "--buildId" ], "description": "ID of the service build, example: joyous-view-6290", "args": [ { "name": "BUILDID" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "containers", "description": "Gets a list of containers for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "branches", "aliases": [ "branch", "brn" ], "description": "Gets information about the branches of the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "pull-requests", "description": "Gets information about the pull-requests of the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-arguments", "description": "Gets the build arguments of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--show" ], "description": "OPTIONAL: Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed., example: all", "args": [ { "name": "SHOW" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-argument-details", "description": "Get details about the build arguments accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment", "description": "Gets the runtime environment of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--show" ], "description": "OPTIONAL: Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed., example: all", "args": [ { "name": "SHOW" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment-details", "description": "Get details about the runtime environment accessible by the given service. Also requires the permission 'Project > Secrets > General > Read'", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "template", "aliases": [ "templates", "tpl" ], "description": "Get information about the given template", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "template-run", "description": "Get information about the given template run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--templateRun", "--templateRunId" ], "description": "ID of the template run, example: 16cf800b-ab28-421a-8ff9-a935b5ee89ad", "args": [ { "name": "TEMPLATERUNID" } ] }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Retrieve a volume", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--volume", "--volumeId" ], "description": "ID of the volume, example: example-volume", "args": [ { "name": "VOLUMEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "delete", "description": "Delete Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "project", "aliases": [ "projects", "prj" ], "description": "Delete the given project. Fails if the project isn't empty", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Deletes the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup-schedule", "description": "Deletes a backup schedule for an addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--schedule", "--scheduleId" ], "description": "ID of the backup schedule, example: 62d5729ab8593e3e33b65105", "args": [ { "name": "SCHEDULEID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "backup", "description": "Deletes a given backup", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "integration", "description": "Delete the given integration. Fails if the integration is associated with existing clusters", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--integration", "--integrationId" ], "description": "ID of the provider integration, example: gcp-integration-1", "args": [ { "name": "INTEGRATIONID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "cluster", "description": "Delete the given cluster. Fails if the cluster has associated projects", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--cluster", "--clusterId" ], "description": "ID of the cluster, example: gcp-cluster-1", "args": [ { "name": "CLUSTERID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Deletes the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "log-sink", "description": "Deletes a log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--logSink", "--logSinkId" ], "description": "ID of the log sink, example: example-log-sink", "args": [ { "name": "LOGSINKID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "registry", "description": "Deletes a set of registry credential data", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--credential", "--credentialId" ], "description": "ID of the registry credential, example: example-credentials", "args": [ { "name": "CREDENTIALID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "domain", "aliases": [ "domains", "dmn" ], "description": "Deletes a domain and each of its registered subdomains", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "subdomain", "description": "Removes a subdomain from a domain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--subdomain" ], "description": "Name of the subdomain, example: app", "args": [ { "name": "SUBDOMAIN" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret", "aliases": [ "secrets", "scrt" ], "description": "Delete a secret", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret-link", "description": "Unlinks an addon from the secret group", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Deletes the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "template", "aliases": [ "templates", "tpl" ], "description": "Delete a template", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Deletes this volume and its associated data", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--volume", "--volumeId" ], "description": "ID of the volume, example: example-volume", "args": [ { "name": "VOLUMEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "--force" ], "description": "OPTIONAL: Don't ask for confirmation" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "scale", "description": "Scale Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Modifies the allocated resources for the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Modifies the scaling settings for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Modifies the scaling settings for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "update", "description": "Update Northflank resource properties", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Update Northflank addon properties", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "version", "description": "Upgrades the addon to a new version", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "network-settings", "description": "Updates the network settings for the addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "security", "description": "Updates the security rules for the addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "integration", "description": "Update information about the given integration", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--integration", "--integrationId" ], "description": "ID of the provider integration, example: gcp-integration-1", "args": [ { "name": "INTEGRATIONID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "cluster", "description": "Update an existing cluster", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--cluster", "--clusterId" ], "description": "ID of the cluster, example: gcp-cluster-1", "args": [ { "name": "CLUSTERID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Update Northflank job properties", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "settings", "description": "Updates settings for the job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "health-checks", "description": "Updates health checks for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-options", "description": "Updates the build options for a given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-source", "description": "Updates the version control source for a given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-arguments", "description": "Sets build arguments for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment", "description": "Sets the runtime environment for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "deployment", "description": "Updates the deployment settings of the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "log-sink", "description": "Updates the settings for a log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--logSink", "--logSinkId" ], "description": "ID of the log sink, example: example-log-sink", "args": [ { "name": "LOGSINKID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "registry", "description": "Updates a set of registry credential data", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--credential", "--credentialId" ], "description": "ID of the registry credential, example: example-credentials", "args": [ { "name": "CREDENTIALID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "release-flow", "description": "Updates a release flow", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret", "aliases": [ "secrets", "scrt" ], "description": "Update a secret", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "secret-link", "description": "Link an addon to the secret group or edit the settings of the linked addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--secret", "--secretId" ], "description": "ID of the secret, example: example-secret", "args": [ { "name": "SECRETID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Update Northflank service properties", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "deployment", "description": "Updates the deployment settings of the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "ports", "description": "Updates the list of ports for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-options", "description": "Updates the build options for a given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-source", "description": "Updates the version control source for a given build or combined service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "health-checks", "description": "Updates health checks for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build-arguments", "description": "Sets the build arguments for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "runtime-environment", "description": "Sets the runtime environment for the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Update volume mounts and storage size", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--volume", "--volumeId" ], "description": "ID of the volume, example: example-volume", "args": [ { "name": "VOLUMEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "backup", "description": "Backup Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Initiates a backup for the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "restore", "description": "Restore Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Addon Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup", "description": "Restores the given addon to the given backup state", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "import", "description": "Import Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Addon Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup", "description": "Imports a database from an external archive or existing live database", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "pause", "description": "Pause Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Pause the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Pause the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "log-sink", "description": "Pauses a given log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--logSink", "--logSinkId" ], "description": "ID of the log sink, example: example-log-sink", "args": [ { "name": "LOGSINKID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Pause the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "resume", "description": "Resume Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Resume the given addon if it is paused", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Resumes the given job. Optionally takes several arguments to override resumed settings", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "log-sink", "description": "Resumes a paused log sink", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--logSink", "--logSinkId" ], "description": "ID of the log sink, example: example-log-sink", "args": [ { "name": "LOGSINKID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Resumes the given service. Optionally takes several arguments to override resumed settings", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "restart", "description": "Restart Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Restart the given addon", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Restarts the given service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "abort", "description": "Abort Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Addon Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup", "description": "Aborts the in progress backup", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "restore", "description": "Aborts an in-progress backup restore", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Job Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "run", "description": "Aborts the given job run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--run", "--runId" ], "description": "ID of the job run, example: d34582a4-35bd-4c71-8e7c-e36999b88723", "args": [ { "name": "RUNID" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build", "description": "Aborts the given job build", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--build", "--buildId" ], "description": "ID of the job build, example: joyous-view-6290", "args": [ { "name": "BUILDID" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "release-flow-run", "description": "Abort the given release flow run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--run", "--runId" ], "description": "ID of the release flow run, example: development", "args": [ { "name": "RUNID" } ] }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Service Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "build", "description": "Aborts the given service build", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--build", "--buildId" ], "description": "ID of the service build, example: joyous-view-6290", "args": [ { "name": "BUILDID" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "template-run", "description": "Abort the given template run", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--templateRun", "--templateRunId" ], "description": "ID of the template run, example: 16cf800b-ab28-421a-8ff9-a935b5ee89ad", "args": [ { "name": "TEMPLATERUNID" } ] }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "retain", "description": "Retain Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Addon Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "backup", "description": "Flags a temporary backup generated by a backup schedule to be retained indefinitely rather than being deleted after the expiry date", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--backup", "--backupId" ], "description": "ID of the backup, example: example-backup", "args": [ { "name": "BACKUPID" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "start", "description": "Start Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "addon", "aliases": [ "addons", "adn" ], "description": "Addon Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "pitr", "description": "Restores an addon to a specific point in time", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--addon", "--addonId" ], "description": "ID of the addon, example: example-addon", "args": [ { "name": "ADDONID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "job", "aliases": [ "jobs" ], "description": "Job Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "run", "description": "Starts a new job run for the given job", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "build", "description": "Start a new build for the given job. Given a commit sha, it will build that commit", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "service", "aliases": [ "services", "svc" ], "description": "Service Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "build", "description": "Start a new build for the given combined or build service. If given a commit sha, it will build that commit. Otherwise, the most recent relevant commit will be built. If the service provided is a build service, a branch name or pull request to build from is required", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--service", "--serviceId" ], "description": "ID of the service, example: example-service", "args": [ { "name": "SERVICEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "suspend", "description": "Suspend Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "job", "aliases": [ "jobs" ], "description": "Modify cron job to toggle suspending of its schedule", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--job", "--jobId" ], "description": "ID of the job, example: example-job", "args": [ { "name": "JOBID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "add", "description": "Add Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "registry", "description": "Adds a new set of container registry credentials to this account", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "domain", "aliases": [ "domains", "dmn" ], "description": "Domain Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "subdomain", "description": "Adds a new subdomain to the domain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "verify", "description": "Verify Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "domain", "aliases": [ "domains", "dmn" ], "description": "Attempts to verify the domain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "subdomain", "description": "Gets details about the given subdomain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--subdomain" ], "description": "Name of the subdomain, example: app", "args": [ { "name": "SUBDOMAIN" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "assign", "description": "Assign Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "subdomain", "description": "Subdomain Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "service", "aliases": [ "services", "svc" ], "description": "Assigns a service port to the given subdomain", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--subdomain" ], "description": "Name of the subdomain, example: app", "args": [ { "name": "SUBDOMAIN" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "unassign", "description": "Unassign Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "subdomain", "description": "Removes a subdomain from its assigned service", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "--subdomain" ], "description": "Name of the subdomain, example: app", "args": [ { "name": "SUBDOMAIN" } ] }, { "names": [ "--domain" ], "description": "Name of the domain, example: example.com", "args": [ { "name": "DOMAIN" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "run", "description": "Run Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "release-flow", "description": "Runs a given release flow with given arguments. This endpoint can be used as part of a CI pipeline to automatically trigger a release process", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--stage" ], "description": "Stage of the pipeline, example: development", "args": [ { "name": "STAGE" } ] }, { "names": [ "--pipeline", "--pipelineId" ], "description": "ID of the pipeline, example: example-pipeline", "args": [ { "name": "PIPELINEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "template", "aliases": [ "templates", "tpl" ], "description": "Run a template", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--template", "--templateId" ], "description": "ID of the template, example: example-template", "args": [ { "name": "TEMPLATEID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "attach", "description": "Attach Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Attach a volume", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--volume", "--volumeId" ], "description": "ID of the volume, example: example-volume", "args": [ { "name": "VOLUMEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "detach", "description": "Detach Northflank resources", "options": [ { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ], "subcommands": [ { "name": "volume", "aliases": [ "volumes", "vol" ], "description": "Detach a volume", "options": [ { "names": [ "--verbose" ], "description": "Verbose output" }, { "names": [ "--quiet" ], "description": "No console output" }, { "names": [ "-f", "--file" ], "description": "File to load resource json from", "args": [ { "name": "file-path" } ] }, { "names": [ "-i", "--input" ], "description": "JSON-formatted resource definition, takes precedence over \"--file\"", "args": [ { "name": "resource-def" } ] }, { "names": [ "--volume", "--volumeId" ], "description": "ID of the volume, example: example-volume", "args": [ { "name": "VOLUMEID" } ] }, { "names": [ "--project", "--projectId" ], "description": "ID of the project, example: default-project", "args": [ { "name": "PROJECTID" } ] }, { "names": [ "--noDefaults" ], "description": "OPTIONAL: Don't use context default values, explicitly use options or ask" }, { "names": [ "-o", "--output" ], "description": "OPTIONAL: Output formatting, options: '--output json|yaml'", "args": [ { "name": "OUTPUT" } ] }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }, { "name": "command-overview", "description": "Prints a tree view of all available commands", "options": [ { "names": [ "--verbose" ], "description": "Print command descriptions" }, { "names": [ "-h", "--help" ], "description": "Display help for command", "priority": 49 } ] }, { "name": "help", "description": "Display help for command", "args": [ { "name": "command", "isOptional": true, "template": "help" } ] } ] }