Type something to search...

Install Astrolock for local development

Development Setup

Install Astrolock with Node.js and Yarn for local development.

Requirements

  • Node.js: v18.0.0 or higher
  • Yarn: v1.22.19
  • OS: macOS, Linux, or Windows (via WSL)
  • Optional: jq (for enhanced JSON parsing)

Install Node.js & Yarn

# macOS
brew install node@18 yarn

# Linux (nvm recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 18 && nvm use 18
npm install -g yarn@1.22.19

# Verify
node --version  # v18.x.x
yarn --version  # 1.22.19

Install Astrolock

git clone https://github.com/eyelock/astrolock.git
cd astrolock && yarn install
bin/astrolock version
# Bash: echo 'export PATH="/path/to/astrolock-template/bin:$PATH"' >> ~/.bashrc
# Zsh:  echo 'export PATH="/path/to/astrolock-template/bin:$PATH"' >> ~/.zshrc
source ~/.bashrc  # or ~/.zshrc

Optional: jq & Updating

# Install jq (enhances JSON parsing)
brew install jq  # macOS
sudo apt-get install jq  # Linux

# Update Astrolock
cd /path/to/astrolock && git pull && yarn install

Troubleshooting

  • Command not found: Add to PATH: export PATH="/path/to/astrolock-template/bin:$PATH"
  • Node version: nvm install 18 && nvm use 18
  • Permission denied: chmod +x /path/to/astrolock-template/bin/astrolock*
  • Yarn not found: npm install -g yarn@1.22.19