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

help command not working #949

Open
kasteph opened this issue May 5, 2022 · 4 comments
Open

help command not working #949

kasteph opened this issue May 5, 2022 · 4 comments
Labels
kind/enhancement Improvement to an existing feature P3 P3: Might be resolved

Comments

@kasteph
Copy link
Contributor

kasteph commented May 5, 2022

Describe the bug:

When running help on any of the lily commands, no help text is printed to stdout.

Steps to Reproduce:

lily help walk

Lily Version:

v0.9.0+dirty

@kasteph kasteph added the kind/bug Kind: Bug label May 5, 2022
@kasteph
Copy link
Contributor Author

kasteph commented May 5, 2022

Also does not work for v0.9.1+rc1

@frrist
Copy link
Member

frrist commented May 5, 2022

Well walk isn't one of the supported arguments for help, so this is mostly expected:

frrist@oak ~/W/s/g/f/lily ((v0.9.1-rc1))> ./lily help
lily help - Shows a list of commands or help for one command

Usage:

  lily help [global options] <command> [arguments...]

The commands are:

   models-list      
   models-describe  
   help, h          Shows a list of commands or help for one command

Use "lily help help <command>" for more information about a command.

Additional help topics:

  overview    Overview of visor
  monitoring  Monitoring lily operation

Use "lily help help <topic>" for more information about

@frrist
Copy link
Member

frrist commented May 5, 2022

This gives a reasonable description:

frrist@oak ~/W/s/g/f/lily ((v0.9.1-rc1))> ./lily walk --help
NAME:
   lily walk - Start a daemon job to walk a range of the filecoin blockchain.

USAGE:
   lily walk [command options] [arguments...]

OPTIONS:
   --tasks value      Comma separated list of tasks to run. Each task is reported separately in the database. [$LILY_TASKS]
   --window value     Duration after which any indexing work not completed will be marked incomplete (default: 5m0s) [$LILY_WINDOW]
   --from HEIGHT      Limit actor and message processing to tipsets at or above HEIGHT (default: 0) [$LILY_FROM]
   --to HEIGHT        Limit actor and message processing to tipsets at or below HEIGHT (default: 0) [$LILY_TO]
   --storage value    Name of storage that results will be written to. [$LILY_STORAGE]
   --api value        Address of lily api in multiaddr format. (default: "/ip4/127.0.0.1/tcp/1231") [$LILY_API]
   --api-token value  Authentication token for lily api. [$LILY_API_TOKEN]
   --name value       Name of job for easy identification later. [$LILY_JOB_NAME]
   --workers value    Sets the number of tipsets that may be simultaneous indexed while walking (default: 1) [$LILY_WALK_WORKERS]
   --help, -h         show help (default: false)

But now that #944 has merged, help will be a lot better in the next release:
e.g.

./lily job run walk -help
NAME:
   lily job run walk - walk and index a range of the filecoin blockchain.

USAGE:
   lily job run walk command [command options] [arguments...]

DESCRIPTION:
   The walk command will index state based on the list of tasks (--tasks) provided over the specified range (--from --to).
   Each epoch will be indexed serially starting from the heaviest tipset at the upper height (--to) to the lower height (--to).
   
   As and example, the below command:
     $ lily job run --tasks=block_headers,messages walk --from=10 --to=20
   walks epochs 20 through 10 (inclusive) executing the block_headers and messages task for each epoch.
   The status of each epoch and its set of tasks can be observed in the visor_processing_reports table.

COMMANDS:
   notify   notify the provided queueing system of epochs to index allowing tipset-workers to perform the indexing.
   help, h  Shows a list of commands or help for one command

OPTIONS:
   --from HEIGHT  Limit actor and message processing to tipsets at or above HEIGHT (default: 0) [$LILY_FROM]
   --to HEIGHT    Limit actor and message processing to tipsets at or below HEIGHT (default: 0) [$LILY_TO]
   --help, -h     show help (default: false)

@kasteph
Copy link
Contributor Author

kasteph commented May 5, 2022

Oh got it, thanks! It would be a nice user experience if we could simplify the help interface of the CLI if it was either just a command or just an option.

@frrist frrist added kind/enhancement Improvement to an existing feature P3 P3: Might be resolved and removed kind/bug Kind: Bug labels Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvement to an existing feature P3 P3: Might be resolved
Projects
None yet
Development

No branches or pull requests

2 participants