Giter Site home page Giter Site logo

Manpage about tundra HOT 2 OPEN

m4tx avatar m4tx commented on July 18, 2024 1
Manpage

from tundra.

Comments (2)

bvdbasch avatar bvdbasch commented on July 18, 2024

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

from tundra.

m4tx avatar m4tx commented on July 18, 2024

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.

from tundra.

Related Issues (12)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.