caoflow

A amazing command line interface to operate caoflow.

• Usage
• Commands

Usage

$ npm install -g caoflow
$ caoflow COMMAND
running command...
$ caoflow (--version)
caoflow/0.0.0 darwin-arm64 node-v20.19.2
$ caoflow --help [COMMAND]
USAGE
  $ caoflow COMMAND
...

Commands

• caoflow autocomplete [SHELL]
• caoflow help [COMMAND]
• caoflow llm auth list
• caoflow llm auth set
• caoflow llm auth sync
• caoflow llm proxy start
• caoflow login
• caoflow openapi
• caoflow openapi codegen
• caoflow user apikey del
• caoflow user apikey gen
• caoflow user apikey get
• caoflow user apikey list
• caoflow user apikey set
• caoflow user set

caoflow autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ caoflow autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ caoflow autocomplete

  $ caoflow autocomplete bash

  $ caoflow autocomplete zsh

  $ caoflow autocomplete powershell

  $ caoflow autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

caoflow help [COMMAND]

Display help for caoflow.

USAGE
  $ caoflow help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for caoflow.

See code: @oclif/plugin-help

caoflow llm auth list

List all LLM auths.

USAGE
  $ caoflow llm auth list [--show-secrets]

FLAGS
  --show-secrets  Show client secrets in the output.

DESCRIPTION
  List all LLM auths.

EXAMPLES
  $ caoflow llm auth list

See code: src/commands/llm/auth/list.ts

caoflow llm auth set

Set LLM auth metadata.

USAGE
  $ caoflow llm auth set --auth-type default|flow --name <value> [--default-auth-meta <value>] [--flow-auth-meta
    <value>] [-f]

FLAGS
  -f, --force                      Force set without confirmation if no related LLM auth metadata found online.
      --auth-type=<option>         (required) Type of the LLM auth metadata to set.
                                   <options: default|flow>
      --default-auth-meta=<value>  Json string of default auth meta, e.g. '{type:'default'}'.
      --flow-auth-meta=<value>     Json string of flow auth meta, e.g. '{type:'flow'}'.
      --name=<value>               (required) Name of the LLM auth metadata to set.

DESCRIPTION
  Set LLM auth metadata.

EXAMPLES
  $ caoflow llm auth set --name <name>
  ✔ Name: <name>
  ✔ Client ID: <client-id>
  ✔ Tenant: <tenant>
  ✔ Client Secret: <client-secret>
  LLM auth metadata <name> has been set successfully.

See code: src/commands/llm/auth/set.ts

caoflow llm auth sync

Sync LLM auth metadata from user apikey.

USAGE
  $ caoflow llm auth sync [-f]

FLAGS
  -f, --force  Force sync without confirmation.

DESCRIPTION
  Sync LLM auth metadata from user apikey.

EXAMPLES
  $ caoflow llm auth sync

See code: src/commands/llm/auth/sync.ts

caoflow llm proxy start

Proxy for LLM API.

USAGE
  $ caoflow llm proxy start [--traffic balance|encourage|none]

FLAGS
  --traffic=<option>  [default: balance] Traffic mode for LLM API.
                      <options: balance|encourage|none>

DESCRIPTION
  Proxy for LLM API.

EXAMPLES
  $ caoflow llm proxy start

  $ caoflow llm proxy start --traffic balance

  $ caoflow llm proxy start --traffic encourage

See code: src/commands/llm/proxy/start.ts

caoflow login

Login to Flow

USAGE
  $ caoflow login [--channel portal]

FLAGS
  --channel=<option>  [default: portal] The channel through which the request is made, affecting the resulting URL.
                      <options: portal>

DESCRIPTION
  Login to Flow

EXAMPLES
  $ caoflow login
  Logging in to Flow...
  A browser window has been opened. Please continue the login in the web browser.
  Browser window has been closed, processing the login result...
  ✔ Email: [email protected]
  ✔ Principal Tenant: yyy
  ✔ Active Tenant: zzz
  You have successfully logged in to Flow!

  $ caoflow login --channel portal

See code: src/commands/login.ts

caoflow openapi

OpenAPI schema preview

USAGE
  $ caoflow openapi --service global-settings|user-api|login-service|knowledge-api|auth-engine-api|all

FLAGS
  --service=<option>  (required) The service to preview the OpenAPI schema for.
                      <options: global-settings|user-api|login-service|knowledge-api|auth-engine-api|all>

DESCRIPTION
  OpenAPI schema preview

EXAMPLES
  $ caoflow openapi --service login-service
  Preview the OpenAPI schema for the login service

See code: src/commands/openapi/index.ts

caoflow openapi codegen

OpenAPI code generation

USAGE
  $ caoflow openapi codegen --service global-settings|user-api|login-service|knowledge-api|auth-engine-api|all

FLAGS
  --service=<option>  (required) The service to preview the OpenAPI schema for.
                      <options: global-settings|user-api|login-service|knowledge-api|auth-engine-api|all>

DESCRIPTION
  OpenAPI code generation

EXAMPLES
  $ caoflow openapi:codegen --service global-settings
  Generating code for service: global-settings
  xxx
  Code generation for service global-settings completed successfully.
  ----------------------------------------

See code: src/commands/openapi/codegen.ts

caoflow user apikey del

Delete an API key for the authenticated user.

USAGE
  $ caoflow user apikey del [-f] [-s <value>]

FLAGS
  -f, --force           Force deletion without confirmation.
  -s, --search=<value>  Search term to filter API keys by name or client ID.

DESCRIPTION
  Delete an API key for the authenticated user.

EXAMPLES
  $ caoflow user apikey del
  Select an API key to delete: my-api-key (xxx)
  Deleting API key my-api-key (xxx)...
  ? Are you sure you want to delete this API key? Yes
  ✔ API key deleted.

  $ caoflow user apikey del --search my-api-key
  Deleting API key my-api-key (xxx)...
  ? Are you sure you want to delete this API key? Yes
  ✔ API key deleted.

See code: src/commands/user/apikey/del.ts

caoflow user apikey gen

Create a new API key for the authenticated user.

USAGE
  $ caoflow user apikey gen [--apps llm-api|metrics-api|agent-runner-api...] [-n <value>]

FLAGS
  -n, --name=<value>      Name of the API key.
      --apps=<option>...  [default: ] Comma-separated list of app names to access with this API key.
                          <options: llm-api|metrics-api|agent-runner-api>

DESCRIPTION
  Create a new API key for the authenticated user.

EXAMPLES
  $ caoflow user apikey gen
  ✔ Enter a name for the API key: caoflow-ec10ca46
  ✔ Select apps to access with this API key: llm-api, metrics-api
  Creating API key ...
  ✔ API key created successfully.
  ✔ Name: caoflow-ec10ca46
  ✔ Apps: llm-api, metrics-api
  ✔ Client ID: xxx
  ✔ Client Secret: yyy
  ✔ Tenant Name: zzz
  You can safely leave this window now, as the client secret cached on disk automatically.
  Or you can run `caoflow user apikey get` to retrieve it later.

  $ caoflow user apikey gen --name my-api-key --apps llm-api,metrics-api

See code: src/commands/user/apikey/gen.ts

caoflow user apikey get

Get Client Secret for the authenticated user.

USAGE
  $ caoflow user apikey get [-s <value>]

FLAGS
  -s, --search=<value>  Search term to filter API keys by name or client ID.

DESCRIPTION
  Get Client Secret for the authenticated user.

EXAMPLES
  $ caoflow user apikey get
  Select an API key to retrieve: my-api-key (xxx)
  ✔ Name: my-api-key
  ✔ Client ID: xxx
  ✔ Client Secret: xxx

  $ caoflow user apikey get --search my-api-key
  ✔ Name: my-api-key
  ✔ Client ID: xxx
  ✔ Client Secret: xxx

See code: src/commands/user/apikey/get.ts

caoflow user apikey list

List all API keys for the authenticated user.

USAGE
  $ caoflow user apikey list [--show-inactive] [--show-secrets]

FLAGS
  --show-inactive  Show inactive API keys in the output.
  --show-secrets   Show client secrets in the output.

DESCRIPTION
  List all API keys for the authenticated user.

EXAMPLES
  $ caoflow user apikey list

  $ caoflow user apikey list --show-inactive

  $ caoflow user apikey list --show-secrets

  $ caoflow user apikey list --inactive --show

See code: src/commands/user/apikey/list.ts

caoflow user apikey set

Set an API key for the authenticated user.

USAGE
  $ caoflow user apikey set [--client-id <value>] [--client-secret <value>] [-f]

FLAGS
  -f, --force                  Force set without confirmation if no related API key found online.
      --client-id=<value>      Client ID of the API key to set.
      --client-secret=<value>  Client Secret of the API key to set.

DESCRIPTION
  Set an API key for the authenticated user.

EXAMPLES
  $ caoflow user apikey set
  ✔ Client ID: xxx
  ✔ Client Secret: ***
  API key set successfully.
  To retrieve the API key, run: `caoflow user apikey get --client-id xxx`

  $ caoflow user apikey set --client-id xxx

  $ caoflow user apikey set --client-id xxx --client-secret yyy

See code: src/commands/user/apikey/set.ts

caoflow user set

Set a default account from the list of authenticated accounts.

USAGE
  $ caoflow user set [--email <value>]

FLAGS
  --email=<value>  The email of the account to set as default.

DESCRIPTION
  Set a default account from the list of authenticated accounts.

EXAMPLES
  $ caoflow user set
  Only one authenticated account found. Setting email:[email protected] as default.
  Default account set to email:[email protected].

  $ caoflow user set --email [email protected]
  Setting email:[email protected] as default.
  Default account set to email:[email protected].

See code: src/commands/user/set.ts