Skip to content

feat: add talm script - #985

Closed
Rashid Alam (7h3-3mp7y-m4n) wants to merge 1 commit into
cozystack:mainfrom
7h3-3mp7y-m4n:script
Closed

Rashid Alam (7h3-3mp7y-m4n) wants to merge 1 commit into
cozystack:mainfrom
7h3-3mp7y-m4n:script

Conversation

@7h3-3mp7y-m4n

@7h3-3mp7y-m4n Rashid Alam (7h3-3mp7y-m4n) commented May 24, 2025 •

Copy link
Copy Markdown

Issue #718

This PR adds a shell script that automatically installs the latest release of Talm based on the system's OS and architecture.

Screenshot 2025-05-24 at 3 25 45 PM

Summary by CodeRabbit

  • New Features
    • Introduced an automated installation script for the Talm CLI tool, supporting multiple operating systems and CPU architectures.
    • The script checks for required dependencies, downloads the appropriate binary, and installs it to a suitable directory.
    • Provides clear, color-coded messages and guidance throughout the installation process.

Signed-off-by: 7h3-3mp7y-m4n <[email protected]>
@coderabbitai

coderabbitai Bot commented May 24, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

A new shell script, install.sh, has been added to automate the installation of the Talm CLI tool. The script manages error handling, environment checks, fetches the latest release from GitHub, selects the appropriate binary based on OS and architecture, and installs it to a suitable directory.

Changes

File(s) Change Summary
scripts/install.sh Added a shell script for automated installation of the Talm CLI, including environment checks and download logic.

Poem

A script to fetch, a script to find,
The Talm CLI, so neatly designed.
With checks and curls, it does prepare,
To place your binary with utmost care.
Now run with joy, let’s raise a cheer—
Talm is installed, the rabbit is here! 🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (7)
scripts/install.sh (7)

5-8: DRY up ANSI color codes

The ANSI escape sequences are repeated across the logging functions. Extract the color codes into variables (e.g., COLOR_INFO, COLOR_ERROR) to reduce duplication and simplify future updates.


10-15: Clarify JSON parsing dependencies

Your dependency check is solid for the current implementation. If you decide to switch to a JSON parser like jq for robustness, be sure to add it to this list. Otherwise, document the current reliance on grep/sed and its limitations.


27-31: Verify OS mapping against asset names

You lowercase uname -s into OS, but ensure this matches the naming convention in the Talm releases (e.g., some projects use darwin vs macos). Add explicit mappings or document supported platforms in the README.


32-40: Extend architecture support

Only common architectures (amd64, arm64, i386) are covered. If Talm publishes for others (e.g., armv7l, s390x), include those in this case block or handle unknown values with a descriptive error.


47-53: Ensure cleanup and handle download errors

Move the trap cleanup EXIT immediately after creating the temp dir to guarantee cleanup on any exit. Additionally, check curl’s exit code explicitly to surface download issues with a custom error message rather than letting set -e abort silently.


54-70: Improve installation directory flexibility

Allow users to override the installation directory via an environment variable (e.g., PREFIX, TALM_INSTALL_DIR) or a --prefix flag. This enhances adaptability in CI environments or custom user setups.


72-76: Safely overwrite existing binaries

Before moving the new binary into place, check if an existing talm binary exists and prompt the user or back it up (e.g., rename to talm.bak). This avoids accidental overwrites:

[ -f "$INSTALL_PATH" ] && mv "$INSTALL_PATH" "$INSTALL_PATH.bak"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8ba6b1 and a448e52.

📒 Files selected for processing (1)
  • scripts/install.sh (1 hunks)
🔇 Additional comments (2)
scripts/install.sh (2)

22-25: Good: graceful handling for missing version

The script correctly checks for an empty LATEST_VERSION and exits with a clear error message, preventing ambiguous failures downstream.


42-44: Validate constructed download URL

Before invoking curl -fL, you can perform a quick HEAD request to catch 404s early:

curl -sfI "$DOWNLOAD_URL" >/dev/null || { error "Release asset not found at $DOWNLOAD_URL"; exit 1; }

This ensures you fail fast on mistyped URLs or missing binaries.

Comment thread scripts/install.sh
Comment on lines +1 to +3
#!/bin/sh

set -e

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance strict mode and portability

Consider using a more portable shebang and stricter error handling. For example, switch to:

#!/usr/bin/env bash
set -euo pipefail
trap 'error "An unexpected error occurred."; exit 1' ERR

This will catch unset variables and pipeline failures more reliably.

🤖 Prompt for AI Agents
In scripts/install.sh at lines 1 to 3, improve script robustness and portability
by changing the shebang from #!/bin/sh to #!/usr/bin/env bash, and enhance error
handling by adding set -euo pipefail to catch unset variables and pipeline
errors. Also, add a trap for ERR to log a custom error message and exit cleanly
on unexpected errors.

Comment thread scripts/install.sh
Comment on lines +19 to +20
LATEST_VERSION=$(curl -fsSL "https://api.github.com/repos/cozystack/talm/releases/latest" | \
grep '"tag_name":' | head -1 | sed -E 's/.*"tag_name": *"([^"]+)".*/\1/')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Robustly fetch GitHub release version

To guard against API rate limits and future schema changes, consider adding the appropriate Accept header:

curl -fsSL -H 'Accept: application/vnd.github.v3+json' "https://api.github.com/repos/cozystack/talm/releases/latest"

Also validate the HTTP status code before parsing, or switch to jq for reliable extraction of tag_name.

🤖 Prompt for AI Agents
In scripts/install.sh around lines 19 to 20, the curl command fetching the
latest GitHub release version lacks the required Accept header and does not
validate the HTTP status code, risking failures due to API rate limits or schema
changes. Modify the curl command to include the header 'Accept:
application/vnd.github.v3+json' and check the HTTP response status before
parsing. Replace the grep and sed parsing with jq to reliably extract the
tag_name field from the JSON response.

@kvaps

Copy link
Copy Markdown
Member

Hey Rashid Alam (@7h3-3mp7y-m4n) thanks for your contribution!

Could you please open another PR to Talm repository?
https://github.com/cozystack/talm

I think this might be more correct plase for storing this script

@7h3-3mp7y-m4n

Copy link
Copy Markdown
Author

Thank you Andrei Kvapil (@kvaps) for catching that, I appreciate it! Apologies for the inconvenience caused by raising the PR in the wrong repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants