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

Add an install.sh script to make installation process simpler for less experienced users #1033

Open
colinlodter opened this issue Dec 4, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@colinlodter
Copy link

I've received feedback that some users are frustrated when they have to manually navigate GitHub releases to download the latest binary for uds-cli or requiring that they have brew installed to get the uds CLI. This process can be time-consuming and confusing, especially for new users who may not be familiar with brew or how to install a specific binary release from GitHub. Providing an automated method would improve the user experience and make the installation process more seamless.

Describe the solution you’d like

•	Given a user `curl`s the `install.sh` script
•	When they execute the `install.sh` script by passing to `bash`
•	Then the script should automatically fetch the latest available binary for `uds` from the GitHub Releases page, validate the download, and prepare the tool for use (e.g., placing it in a specified directory).

Describe alternatives you’ve considered

•	Using a package manager to handle installations (e.g., Homebrew, Chocolatey), but this requires additional setup and maintenance.

Additional context

•	The install.sh script should:
•	Identify and fetch the latest release version.
•	Ensure compatibility with the user’s operating system and architecture.
•	Provide user-friendly error messages in case of failure (when in debug mode).
•	This will require adding a note in the README to document how the script works and its prerequisites (e.g., curl availability).
@colinlodter colinlodter added the enhancement New feature or request label Dec 4, 2024
@colinlodter
Copy link
Author

PR: #1034

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

1 participant