Skip to content

installation.md

Latest commit

 

History

History
140 lines (93 loc) · 2.77 KB

installation.md

File metadata and controls

140 lines (93 loc) · 2.77 KB

Installation

Python (uv)

uv handles Python and dependencies automatically.

Install uv (if you don't have it):

curl -LsSf https://astral.sh/uv/install.sh | sh

Install ascend-tools as a CLI tool:

uv tool install ascend-tools

Upgrade to the latest version:

uv tool install --upgrade ascend-tools

Run without installing:

uvx ascend-tools workspace list

Python SDK

Add ascend-tools as a dependency in your Python project:

uv add ascend-tools

Node.js (npm)

Install ascend-tools globally:

npm install -g ascend-tools

Upgrade to the latest version:

npm update -g ascend-tools

Run without installing:

npx ascend-tools workspace list

JavaScript SDK

Add ascend-tools as a dependency in your Node.js project:

npm add ascend-tools

GitHub releases (pre-built binaries)

Pre-built binaries are available for Linux and macOS. No Python, Node.js, or Rust toolchain required.

Available platforms

Platform Archive
macOS (Apple Silicon) ascend-tools-<VERSION>-aarch64-apple-darwin.tar.gz
macOS (Intel) ascend-tools-<VERSION>-x86_64-apple-darwin.tar.gz
Linux (ARM64) ascend-tools-<VERSION>-aarch64-unknown-linux-gnu.tar.gz
Linux (x86_64) ascend-tools-<VERSION>-x86_64-unknown-linux-gnu.tar.gz

Install with gh CLI

# Download the latest release for your platform
gh release download --repo ascend-io/ascend-tools --pattern "*aarch64-apple-darwin*"

# Extract
tar xzf ascend-tools-*.tar.gz

# Move to a directory on your PATH
mv ascend-tools /usr/local/bin/

Install with curl

# Set version and platform
VERSION="v0.0.0"  # replace with desired version
PLATFORM="aarch64-apple-darwin"

# Download and extract
curl -L "https://github.com/ascend-io/ascend-tools/releases/download/${VERSION}/ascend-tools-${VERSION}-${PLATFORM}.tar.gz" | tar xz

# Move to a directory on your PATH
mv ascend-tools /usr/local/bin/

Verify

ascend-tools --version

Cargo (Rust)

Not yet published on crates.io. Contact your Ascend representative if you're interested in Cargo installation.

cargo install ascend-tools-cli     # CLI binary
cargo add ascend-tools-core        # Rust SDK (library dependency)

Verify installation

Regardless of install method, verify everything is working:

ascend-tools --version

Then set up authentication and test connectivity:

export ASCEND_SERVICE_ACCOUNT_ID="<YOUR_SERVICE_ACCOUNT_ID>"
export ASCEND_SERVICE_ACCOUNT_KEY="<YOUR_SERVICE_ACCOUNT_KEY>"
export ASCEND_INSTANCE_API_URL="<YOUR_INSTANCE_API_URL>"

ascend-tools workspace list

See the Quickstart for the full setup walkthrough.