StackStorm / StackStorm/st2

Help for 'st2 run <pack-name>' should include an example on how to use the command

Open
#2,743 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

trying to figure out the exact command syntax for command:

st2 run linux.dig -h

the output do not show any help on exact syntax to execute the command

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running st2 run linux.dig -h and tracing the st2 run CLI help entry point. Update the relevant help text to include an exact command-use example, then rerun the command to verify that the example appears and is syntactically clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.