faas-cli icon indicating copy to clipboard operation
faas-cli copied to clipboard

docs(install): Enhance CLI installation guide with OS-specific steps and Arkade option

Open davmano opened this issue 7 months ago โ€ข 2 comments

This PR enhances the README.md with a comprehensive Quick Start Installation Guide for faas-cli. It introduces:

โœ… Arkade-based installation (recommended)

๐Ÿง Linux/macOS setup with root and non-root options

๐Ÿบ Homebrew installation for macOS

๐ŸชŸ PowerShell instructions for Windows users

โœ… Command to verify successful installation

๐Ÿงช First function deployment example for onboarding

Purpose & Benefits:

These changes aim to:

  • ๐Ÿš€ Improve onboarding experience for new users

  • ๐Ÿงญ Provide OS-specific clarity

  • ๐Ÿค Align with OpenFaaS documentation and community standards

โœ… Checklist

  • My changes follow the contributing guidelines

  • I've tested the installation instructions

  • All markdown renders cleanly and clearly

  • No existing content was removed unnecessarily

davmano avatar May 07 '25 20:05 davmano

Thank you for your contribution. unfortunately, one or more of your commits are missing the required "Signed-off-by:" statement. Signing off is part of the Developer Certificate of Origin (DCO) which is used by this project.

Read the DCO and project contributing guide carefully, and amend your commits using the git CLI. Note that this does not require any cryptography, keys or special steps to be taken.

:bulb: Shall we fix this?

This will only take a few moments.

First, clone your fork and checkout this branch using the git CLI.

Next, set up your real name and email address:

git config --global user.name "Your Full Name" git config --global user.email "[email protected]"

Finally, run one of these commands to add the "Signed-off-by" line to your commits.

If you only have one commit so far then run: git commit --amend --signoff and then git push --force. If you have multiple commits, watch this video.

Check that the message has been added properly by running "git log".

derek[bot] avatar May 07 '25 20:05 derek[bot]

Hi, I think we missed this.. we can look at adding arkade as an installation option. I think it may already be in the docs? Most users land on the docs rather than the README - so if anything, we could remove some of the README's duplication and focus on the code for this repo.

alexellis avatar Nov 13 '25 18:11 alexellis