Skip to content

Conversation

timothyF95
Copy link
Contributor

@timothyF95 timothyF95 commented Oct 20, 2025

leishi@MB-MJ2FP47WKD cre-cli % cre help
A command line tool for building, testing and managing Chainlink Runtime Environment (CRE) workflows.

Usage:
  cre [command]

Available Commands:
Getting Started:
  init               Initialize a new cre project (recommended starting point)
Account:
  account            Manages account
  login              Start authentication flow
  logout             Revoke authentication tokens and remove local credentials
  whoami             Show your current account details
Workflow:
  workflow           Manages workflows
Secret:
  secrets            Handles secrets management
Other:
  generate-bindings  Generate bindings from contract ABI
  version            Print the cre version

Flags:
  -e, --env string            Path to .env file which contains sensitive info (default ".env")
  -h, --help                  help for cre
  -R, --project-root string   Path to the project root
  -T, --target string         Use target settings from YAML config
  -v, --verbose               Run command in VERBOSE mode

Use "cre [command] --help" for more information about a command.

💡 Tip: New here? Run:
  cre init
  to create your first cre project.

📘 Need more help?
  Visit https://docs.chain.link/cre
leishi@MB-MJ2FP47WKD cre-cli % cre workflow help
The workflow command allows you to register and manage existing workflows.

Usage:
  cre workflow [command]

Available Commands:
  activate     Activates workflow on the Workflow Registry contract
  delete       Deletes all versions of a workflow from the Workflow Registry
  deploy       Deploys a workflow to the Workflow Registry contract
  pause        Pauses workflow on the Workflow Registry contract
  simulate     Simulates a workflow

Flags:
  -h, --help   help for workflow

Global Flags:
  -e, --env string            Path to .env file which contains sensitive info (default ".env")
  -R, --project-root string   Path to the project root
  -T, --target string         Use target settings from YAML config
  -v, --verbose               Run command in VERBOSE mode

Use "cre workflow [command] --help" for more information about a command.

💡 Tip: New here? Run:
  cre init
  to create your first cre project.

📘 Need more help?
  Visit https://docs.chain.link/cre
leishi@MB-MJ2FP47WKD cre-cli % cre secrets help
Create, update, delete, list secrets in Vault DON.

Usage:
  cre secrets [command]

Available Commands:
  create       Creates secrets from a YAML file.
  delete       Deletes secrets from a YAML file provided as a positional argument.
  execute      Executes a previously prepared MSIG bundle (.json): verifies allowlist and POSTs the exact saved request.
  list         Lists secret identifiers for the current owner address in the given namespace.
  update       Updates existing secrets from a file provided as a positional argument.

Flags:
  -h, --help               help for secrets
      --timeout duration   Timeout for secrets operations (e.g. 30m, 2h, 48h). (default 48h0m0s)

Global Flags:
  -e, --env string            Path to .env file which contains sensitive info (default ".env")
  -R, --project-root string   Path to the project root
  -T, --target string         Use target settings from YAML config
  -v, --verbose               Run command in VERBOSE mode

Use "cre secrets [command] --help" for more information about a command.

💡 Tip: New here? Run:
  cre init
  to create your first cre project.

📘 Need more help?
  Visit https://docs.chain.link/cre

@shileiwill shileiwill marked this pull request as ready for review October 22, 2025 03:33
@shileiwill shileiwill requested a review from a team as a code owner October 22, 2025 03:33
cmd/root.go Outdated
accountCmd.GroupID = "account"
whoamiCmd.GroupID = "account"

secretsCmd.GroupID = "workflow"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is debatable bc secrets is in its own module, cre secrets create. generate-binding doesnt belong to any module. same thing applies to login/logout and whoami.

@ejacquier let me know if this is how you want to group the commands. happy to adjust.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved secrets to its own module
moved genbinding to others.

Usage:
{{.CommandPath}} [command]
Available Commands:
Copy link
Collaborator

@anirudhwarrier anirudhwarrier Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. can Available Commands be shown only if there are sub-commands. right now for commands like init, version, login and any sub-command like workflow/deploy if you do --help, it prints out empty Available Commands:
    Eg:
❯ cre workflow deploy --help
Compiles the workflow, uploads the artifacts, and registers the workflow in the Workflow Registry contract.

Usage:
  cre workflow deploy [command]

Available Commands:

Flags:
  -r, --auto-start           Activate and run the workflow after registration, or pause it
                             (default true)
  -h, --help                 help for deploy
  -o, --output string        The output file for the compiled WASM binary encoded in base64
                             (default "./binary.wasm.br.b64")
  -l, --owner-label string   Label for the workflow owner (used during auto-link if owner is
                             not already linked)
      --unsigned             If set, the command will either return the raw transaction
                             instead of sending it to the network or execute the second step
                             of secrets operations using a previously generated raw transaction
      --yes                  If set, the command will skip the confirmation prompt and proceed
                             with the operation even if it is potentially destructive

Use "cre workflow deploy [command] --help" for more information about a command.

💡 Tip: New here? Run:
  cre init
  to create your first cre project.

📘 Need more help?
  Visit https://docs.chain.link/cre
  1. Also the Examples and Global Flags are no longer shown now, while it was previously. It should be brought back?
❯ cre workflow deploy --help
Compiles the workflow, uploads the artifacts, and registers the workflow in the Workflow Registry contract.

Usage:
  cre workflow deploy <workflow-folder-path> [flags]

Examples:

		cre workflow deploy ./my-workflow


Flags:
  -r, --auto-start           Activate and run the workflow after registration, or pause it (default true)
  -h, --help                 help for deploy
  -o, --output string        The output file for the compiled WASM binary encoded in base64 (default "./binary.wasm.br.b64")
  -l, --owner-label string   Label for the workflow owner (used during auto-link if owner is not already linked)
      --unsigned             If set, the command will either return the raw transaction instead of sending it to the network or execute the second step of secrets operations using a previously generated raw transaction
      --yes                  If set, the command will skip the confirmation prompt and proceed with the operation even if it is potentially destructive

Global Flags:
  -e, --env string            Path to .env file which contains sensitive info (default ".env")
  -R, --project-root string   Path to the project root
  -T, --target string         Set the target settings
  -v, --verbose               Print DEBUG logs

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch @anirudhwarrier

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated. please see test plan for details.

Copy link
Collaborator

@anirudhwarrier anirudhwarrier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now

@shileiwill shileiwill added this pull request to the merge queue Oct 22, 2025
Merged via the queue into main with commit dda75e3 Oct 22, 2025
16 checks passed
@shileiwill shileiwill deleted the onboarding-fixes branch October 22, 2025 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants