Skip to content

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

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.

Sign up for GitHub

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

Merged
almostintuitive merged 2 commits into from
Mar 28, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80c0781
fix(install): install binary to /usr/local/bin instead of current dir…
claude Mar 28, 2026
7763180
fix(Docs): update example symbol to perpetual-BTC-USDT:USDT
claude Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ aperiodic symbols --exchange binance-futures
```bash
aperiodic ohlcv \
--exchange binance-futures \
--symbol BTC-USDT-PERP \
--symbol perpetual-BTC-USDT:USDT \
--interval 1h \
--start-date 2024-01-01 \
--end-date 2024-03-31 \
Expand All @@ -127,7 +127,7 @@ aperiodic ohlcv \
```bash
aperiodic flow \
--exchange binance-futures \
--symbol BTC-USDT-PERP \
--symbol perpetual-BTC-USDT:USDT \
--interval 1h \
--start-date 2024-01-01 \
--end-date 2024-03-31 \
Expand All @@ -138,7 +138,7 @@ aperiodic flow \
```bash
aperiodic basis \
--exchange binance-futures \
--symbol BTC-USDT-PERP \
--symbol perpetual-BTC-USDT:USDT \
--interval 1h \
--start-date 2024-01-01 \
--end-date 2024-03-31 \
Expand Down
16 changes: 13 additions & 3 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,24 @@ else
URL="https://github.com/$REPO/releases/download/$VERSION/aperiodic-$OS-$ARCH$EXT"
fi

INSTALL_DIR="/usr/local/bin"

echo "Detected OS: $OS, Architecture: $ARCH"
echo "Downloading Aperiodic CLI from $URL..."

if ! curl -L -o "$BINARY_NAME" "$URL"; then
TMP_FILE=$(mktemp)
if ! curl -L -o "$TMP_FILE" "$URL"; then
echo "Error: Failed to download binary. Please check the repository and version."
rm -f "$TMP_FILE"
exit 1
fi

chmod +x "$BINARY_NAME"
chmod +x "$TMP_FILE"

if [ -w "$INSTALL_DIR" ]; then
mv "$TMP_FILE" "$INSTALL_DIR/$BINARY_NAME"
else
sudo mv "$TMP_FILE" "$INSTALL_DIR/$BINARY_NAME"
fi

echo "Installation complete. You can now run ./$BINARY_NAME"
echo "Installation complete. Run 'aperiodic' to get started."
Loading