Improve install script robustness #29
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Installation Script Enhancements for Shell-AI
This document details the significant improvements made to the installation scripts for the Shell-AI tool, enhancing their robustness and user-friendliness across various platforms.
Context
The install script previously worked inconsistently, especially on managed machines with multiple users. This led to challenges in ensuring a smooth installation experience.
Task
The script has been updated to work consistently and intuitively across more Linux distributions and setups, drawing on examples from existing
install.shscripts.Overview
The installation scripts are designed to facilitate seamless setup for users on different operating systems. They address potential challenges and ensure a smooth installation experience.
Key Features
Cross-Platform Compatibility: The scripts automatically detect the operating system and architecture to provide the appropriate installation method.
User-Level Installation: By default, the tool installs in
~/.local/binfor regular users, with the option to install in/usr/local/binif executed with root privileges.Essential Tool Checks: The scripts verify the presence of required tools, specifically
curlandunzip, and gracefully exit with informative error messages if they are missing.Dynamic Architecture Detection: Utilizing the
uname -mcommand, the scripts detect the system architecture to ensure the correct binary version is downloaded.Robust Error Handling: The scripts include checks for download and extraction failures, guiding users to troubleshoot issues effectively.
Automatic PATH Management: If the installation directory is not already included in the user’s
PATH, the script appends it, ensuring easy access to the tool after installation.Thank you,