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

Manpage #37

Open
m4tx opened this issue Aug 13, 2022 · 2 comments
Open

Manpage #37

m4tx opened this issue Aug 13, 2022 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@m4tx
Copy link
Owner

m4tx commented Aug 13, 2022

We could add a manpage, especially since we could potentially use something like https://crates.io/crates/clap_mangen to do that automatically.

@m4tx m4tx added enhancement New feature or request good first issue Good for newcomers labels Aug 13, 2022
@bvdbasch
Copy link

Hi,

I'm showing up here because this was marked as a good first issue. I work on a Linux system on daily basis, so I figured it would actually be a fun little exercise for me to create a man page.

I have a question before I can make the man page a reality though. The README.md states:

### CLI
Tundra has CLI interface as well. First, you need to authenticate:

`tundra authenticate <username> <password>`

Then, you can run Tundra as a daemon:

`tundra daemon`

This way, Tundra will periodically check for players running and scrobble any anime videos to your MAL account, just like the GUI version. 

Does this mean that the CLI only has two commands?

I look forward to hearing from you.

~Bonno

@m4tx
Copy link
Owner Author

m4tx commented Aug 13, 2022

Hey, thanks for being interested in that! Yes, at this moment there are only two subcommands available. For this reason, the manpage isn't really necessary, but as you've said, it might be fun to actually have one. This might also be a good time to try to add a bit more description to the CLI commands (or think about some additional ones as well). In the essence, we would like the manpage to have pretty much the same info as tundra --help, along with help pages for all subcommands.

Also, I would recommend trying to generate those manpages automatically (e.g. by using the library I've linked in the issue) - because they are just "nice to have", it would be nice if they wouldn't need any additional maintenance later.

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

No branches or pull requests

2 participants