Guide users to install huggingface-cli to login to huggingface

[pbabinca]

Relates-to: #643

Summary by Sourcery

Documentation:

• Document the requirement for the huggingface-cli tool when logging in to Hugging Face.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a note to the documentation that the huggingface-cli tool is required to login to huggingface. It also adds a link to the huggingface documentation on how to install and use the tool.

Sequence diagram for Huggingface login flow

sequenceDiagram
    actor User
    participant CLI as Ramalama CLI
    participant HF as huggingface-cli
    participant Hub as Huggingface Hub

    User->>CLI: ramalama login --token=XYZ huggingface
    Note over CLI: Requires huggingface-cli
    CLI->>HF: Use huggingface-cli
    HF->>Hub: Authenticate with token
    Hub-->>HF: Authentication response
    HF-->>CLI: Authentication result
    CLI-->>User: Login status

Loading

File-Level Changes

Change	Details	Files
Added a note to the documentation that the huggingface-cli tool is required to login to huggingface.	Added a sentence to the documentation that the huggingface-cli tool is required to login to huggingface. Added a link to the huggingface documentation on how to install and use the tool.	docs/ramalama-login.1.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @pbabinca - I've reviewed your changes - here's some feedback:

Overall Comments:

• The link format contains an extra parenthesis - please change ]: (https... to ]: https...

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[rhatdan]

Thanks @pbabinca
Please sign and squash your commits.

[ericcurtin]

Might need to do a squash also, a problem with committing the bots suggestions in the web ui, is the bot can't sign a commit under someones name.

[ericcurtin]

CI also complained we use invalid syntax in the docs, we need to fix that:

hack/xref-helpmsgs-manpages
xref-helpmsgs-manpages: docs/ramalama-login.1.md:56: '[documentation of Command Line Interface (CLI) of Hub Python Library on Hugging Face]: (https://huggingface.co/docs/huggingface_hub/en/guides/cli)' should be bracketed by '**'
make: *** [Makefile:110: validate] Error 1
Error: Process completed with exit code 2.

[pbabinca]

CI also complained we use invalid syntax in the docs, we need to fix that:

Well, this is tricky. I thought of providing link to documentation and locally the change rendered correctly:

hack/xref-helpmsgs-manpages
xref-helpmsgs-manpages: docs/ramalama-login.1.md:56: '[documentation of Command Line Interface (CLI) of Hub Python Library on Hugging Face]: (https://huggingface.co/docs/huggingface_hub/en/guides/cli)' should be bracketed by '**'
make: *** [Makefile:110: validate] Error 1
Error: Process completed with exit code 2.

This one suggest use of brackets by **. But that does not make sense here because link ends up to be inline (see screenshot above) and the sourcery-ai suggests removal of column : but that would break inline link:

## SEE ALSO
**[ramalama(1)](ramalama.1.md)**

**[documentation of Command Line Interface (CLI) of Hub Python Library on Hugging Face](https://huggingface.co/docs/huggingface_hub/en/guides/cli)**

Ends up to be:

I haven't found external hyperlinks in ramalama nor podman so I'm not sure what would be preferred way to make CI happy.

Do you have any suggestions how to approach this?

[rhatdan]

Logging in to Hugging Face requires the `huggingface-cli` tool. For installation and usage instructions, see [*documentation of Command Line Interface (CLI) of Hub Python Library on Hugging Face*].

[rhatdan]

Add a line break here.

[rhatdan]

Eliminate the SeeAlso section.

And change to:

+Logging in to Hugging Face requires the `huggingface-cli` tool. For installation and usage instructions, see the [*documentation of Command Line Interface CLI of Hub Python Library on Hugging Face*](https://huggingface.co/docs/huggingface_hub/en/guides/cli).

[pbabinca]

Eliminate the SeeAlso section.

And change to:

+Logging in to Hugging Face requires the `huggingface-cli` tool. For installation and usage instructions, see the [*documentation of Command Line Interface CLI of Hub Python Library on Hugging Face*](https://huggingface.co/docs/huggingface_hub/en/guides/cli).

Building this locally as a man page and rendering with it with: make docs && man -l docs/ramalama-login.1 does not display link at all:

[pbabinca]

My latest attempt to use reference style links seem to pass tests and also renders correctly in man page and that link is even visible there:

[rhatdan]

How about:
patch

[pbabinca]

How about: patch

Done and IMHO it still looks fine in man page. 👍