@arascorp/edge-install
v1.0.2
Published
Edge CLI Installer for Aras artifacts - easily install and manage Aras tools via npx
Readme
Aras Edge Installer
A convenient Edge CLI Installer for Aras artifacts that downloads platform-specific binaries via npm packages.
Architecture
The Edge Installer consists of:
@arascorp/edge-install- Main wrapper package (this package)@arascorp/edge-cli-linux- Linux x64 binaries@arascorp/edge-cli-osx- macOS (Darwin) x64 binaries@arascorp/edge-cli-windows- Windows x64 binaries
Quick Start
# Install edgecli to ~/.arascorp/bin with automatic PATH setup
npx @arascorp/edge-install edgecli
# Install to specific directory
npx @arascorp/edge-install edgecli -d /usr/local/bin
# Force installation (overwrite existing)
npx @arascorp/edge-install edgecli --force
# Install for specific platform
npx @arascorp/edge-install edgecli --platform linuxAfter installation, you can immediately use the tool:
edgecli --help # Works immediately - no terminal restart needed!Usage
arascorp-edge-install <artifact> [options]
Arguments:
artifact artifact name to install
Options:
-V, -v, --version output the current version
-d, --directory <dir> installation directory (default: ~/.arascorp/bin)
-f, --force force installation (overwrite existing) (default: false)
--platform <platform> target platform (linux, windows, osx) (default: auto-detected)
--verbose verbose output (default: false)
-h, --help display help for commandSupported Artifacts
edgecli- Edge Builder CLI utility
Examples
Basic Installation
# Install edgecli to ~/.arascorp/bin with auto-PATH setup
npx @arascorp/edge-install edgecli
# Immediately available - no restart needed!
edgecli --helpCustom Directory
# Install to system-wide location
npx @arascorp/edge-install edgecli -d /usr/local/bin
# Install to user bin directory (manual PATH setup required)
npx @arascorp/edge-install edgecli -d ~/.local/binPlatform-Specific Installation
# Force Linux binary (useful in containers)
npx @arascorp/edge-install edgecli --platform linux
# Install Windows binary
npx @arascorp/edge-install edgecli --platform windowsDevelopment & Debugging
# Verbose output for troubleshooting
npx @arascorp/edge-install edgecli --verbose
# Force overwrite existing installation
npx @arascorp/edge-install edgecli --forceHow it Works
- Platform Detection: Automatically detects your operating system
- Default Installation: Installs to
~/.arascorp/binby default - Package Download: Downloads the appropriate
@arascorp/edge-cli-{platform}package - Binary Extraction: Extracts the binary from the downloaded package
- PATH Setup: Automatically adds
~/.arascorp/binto your shell's PATH - Immediate Activation: Updates PATH in current session for instant access
- Cleanup: Removes temporary files
When using the default directory, the edge installer automatically configures your shell profile (.bashrc, .zshrc, etc.) and immediately activates the PATH in your current terminal session, so installed tools are available right away.
Directory Structure
The edge installer downloads from these npm packages:
@arascorp/edge-cli-linux # Linux x64 binaries
@arascorp/edge-cli-osx # macOS x64 binaries
@arascorp/edge-cli-windows # Windows x64 binariesPATH Setup
When installing to the default directory (~/.arascorp/bin), the edge installer automatically:
- Creates the
~/.arascorp/bindirectory if it doesn't exist - Detects your shell (bash, zsh, etc.)
- Updates your shell profile (
.bashrc,.zshrc,.profile) to include~/.arascorp/binin PATH - Activates PATH immediately in the current terminal session
- Makes tools available right away - no terminal restart needed!
For custom installation directories, you'll need to manually add the directory to your PATH:
Linux/macOS
export PATH="/path/to/installation:$PATH"
# Add to ~/.bashrc or ~/.zshrc for persistenceWindows
Add the installation directory to your PATH environment variable through:
- System Properties → Environment Variables
- Or use PowerShell:
$env:PATH += ";C:\path\to\installation"
Requirements
- Node.js 14.0.0 or higher
- Supported platforms: Linux, macOS, Windows
License
ISC
