Skip to content

fix(Docs): Improve installation process and update documentation#10

Merged
almostintuitive merged 2 commits into
mainfrom
claude/fix-install-script-aQwLg
Mar 28, 2026
Merged

fix(Docs): Improve installation process and update documentation#10
almostintuitive merged 2 commits into
mainfrom
claude/fix-install-script-aQwLg

Conversation

@almostintuitive

Copy link
Copy Markdown
Contributor

Summary

This PR improves the installation script to properly install the binary to a system directory and updates documentation to reflect correct symbol naming conventions.

Key Changes

Installation Script (install.sh):

  • Use temporary file during download to avoid leaving incomplete binaries in the current directory
  • Install binary to /usr/local/bin instead of current directory, making it globally accessible
  • Automatically use sudo when necessary if the installation directory is not writable
  • Update completion message to reflect that the binary is now available as a global command

Documentation (README.md):

  • Update perpetual futures symbol format from BTC-USDT-PERP to perpetual-BTC-USDT:USDT across all examples (ohlcv, flow, and basis commands)
  • Ensures documentation matches the actual symbol naming convention used by the application

Implementation Details

  • The installation now uses mktemp to create a temporary file for the download, which is then moved to the final location
  • Proper error handling ensures the temporary file is cleaned up if the download fails
  • The script intelligently handles permission issues by attempting a direct move first, then falling back to sudo if needed
  • Users can now run aperiodic directly from any directory after installation, rather than needing to reference it with ./

https://claude.ai/code/session_01KriqNVbEfa4zvw9xAh8nj5

@almostintuitive almostintuitive changed the title Improve installation process and update documentation fix(Docs): Improve installation process and update documentation Mar 28, 2026
@almostintuitive
almostintuitive marked this pull request as ready for review March 28, 2026 10:21
@almostintuitive
almostintuitive merged commit dc1d1af into main Mar 28, 2026
10 checks passed
@almostintuitive
almostintuitive deleted the claude/fix-install-script-aQwLg branch March 28, 2026 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants