Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort command list #991

Closed
YamatoSecurity opened this issue Apr 8, 2023 · 2 comments · Fixed by #1000
Closed

Sort command list #991

YamatoSecurity opened this issue Apr 8, 2023 · 2 comments · Fixed by #1000
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@YamatoSecurity
Copy link
Collaborator

YamatoSecurity commented Apr 8, 2023

When hayabusa is ran without any arguments, the list of commands is shown:

  csv-timeline         Save the timeline in CSV format
  json-timeline        Save the timeline in JSON/JSONL format
  logon-summary        Print a summary of successful and failed logons
  metrics              Print event ID metrics
  pivot-keywords-list  Create a list of pivot keywords
  search               Search by keyword
  update-rules         Update to the latest rules in the hayabusa-rules github repository
  level-tuning         Tune alert levels (default: ./rules/config/level_tuning.txt)
  set-default-profile  Set default output profile
  list-contributors    Print the list of contributors
  list-profiles        List the output profiles
  help                 Print this message or the help of the given subcommand(s)

After the search command is implemented, I would like to sort them as follows:

Commands:
csv-timeline         Save the timeline in CSV format
help                 Print this message or the help of the given subcommand(s)
json-timeline        Save the timeline in JSON/JSONL format
level-tuning         Tune alert levels (default: ./rules/config/level_tuning.txt)
list-contributors    Print the list of contributors
list-profiles        List the output profiles
logon-summary        Print a summary of successful and failed logons
metrics              Print event ID metrics
pivot-keywords-list  Create a list of pivot keywords
search               Search by keyword
set-default-profile  Set default output profile
update-rules         Update to the latest rules in the hayabusa-rules github repository

If it is possible to organize the commands into groups then this is better:

Analysis Commands:
logon-summary        Print a summary of successful and failed logons
metrics              Print event ID metrics
pivot-keywords-list  Create a list of pivot keywords
search               Search by keyword

DFIR Timeline Commands:
csv-timeline         Save the timeline in CSV format
json-timeline        Save the timeline in JSON/JSONL format
level-tuning         Tune alert levels (default: ./rules/config/level_tuning.txt)
list-profiles        List the output profiles
set-default-profile  Set default output profile
update-rules         Update to the latest rules in the hayabusa-rules github repository

General Commands:
help                 Print this message or the help of the given subcommand(s)
list-contributors    Print the list of contributors
@YamatoSecurity YamatoSecurity added the enhancement New feature or request label Apr 8, 2023
@YamatoSecurity YamatoSecurity added this to the v2.4.0 milestone Apr 8, 2023
@hitenkoku hitenkoku self-assigned this Apr 8, 2023
@hitenkoku
Copy link
Collaborator

hitenkoku commented Apr 12, 2023

@YamatoSecurity

The command grouping was also created in clap but still did not work (I set subcommand_help_heading in clap v4 but it did not change).

refs: clap-rs/clap#1553

hitenkoku added a commit that referenced this issue Apr 12, 2023
@hitenkoku hitenkoku linked a pull request Apr 12, 2023 that will close this issue
@YamatoSecurity
Copy link
Collaborator Author

@hitenkoku I see. That is too bad it is not supported in clap yet. Maybe one day. Thank you for trying to implement it though!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants