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

Command Help Support #5

Open
ghostdevv opened this issue Jan 17, 2024 · 2 comments
Open

Command Help Support #5

ghostdevv opened this issue Jan 17, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@ghostdevv
Copy link
Owner

off the top of my head:

  1. Add a field to the pkg def something like "help": "<file>"
  2. Create a .carl/help directory in setup script
  3. When a package is installed if there is a help file copy it to that directory
  4. In bootstrap set the help path
@ghostdevv ghostdevv added the enhancement New feature or request label Jan 17, 2024
@ghostdevv
Copy link
Owner Author

Should we enforce a help text for CLIs? If so should the pkg def be changed to something like:

{
	"cli": {
		"file": "<file>",
		"help": "<file>"
	}
}

I'm not sure what the answer to the question is but we should probably make it an object regardless to future proof

@brooke-ec
Copy link
Collaborator

It would be better to specify the URL of the help file as it does not need to be duplicated in the package directory as well as the .carl/help directory.

As for requiring a help file - I think its a good idea to avoid unexpected behavior. If not, we could have it generate a fallback help file?

I also think its a great idea to use an object. Personally, I would change file to be entrypoint but I'll leave that up to your preference.

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

No branches or pull requests

2 participants