Antarys

|

Antarys

Quick Installation

Install Antarys vector database on macOS and Linux with one-liner command or manual download.

Installing Antarys

Get started with Antarys vector database on supported platforms using our automated installer or manual downloads.

Preview Release: Antarys is currently in preview. Features and APIs may change between releases.

Platform Support

Antarys currently supports the following platforms:

Apple ARM

macOS with Apple Silicon (M1/M2/M3 chips)

Linux x64

Linux distributions with x86_64 architecture

Quick Install

The fastest way to install Antarys on supported platforms:

curl -fsSL http://antarys.ai/start.sh | bash

Auto-detection: The installer automatically detects your platform and installs the appropriate version.

Manual Installation

If you prefer manual installation or need more control over the process:

Download the Package

Download the macOS installer package:

curl -L -o antarys-apple-arm.pkg \
  https://github.com/antarys-ai/antarys-releases/releases/download/preview/antarys-apple-arm.pkg

Install the Package

Install using the macOS installer:

sudo installer -pkg antarys-apple-arm.pkg -target /

Admin Rights: This command requires administrator privileges to install system-wide.

Verify Installation

Check that Antarys is installed correctly:

which antarys

Download the Archive

Download the Linux binary archive:

curl -L -o antarys-linux-x64.zip \
  https://github.com/antarys-ai/antarys-releases/releases/download/preview/antarys-linux-x64.zip

Extract and Install

Extract and install the binary:

# Extract the archive
unzip antarys-linux-x64.zip

# Install to system directory
sudo cp antarys /usr/bin/antarys
sudo chmod +x /usr/bin/antarys

Verify Installation

Check that Antarys is installed correctly:

which antarys

Getting Started

Once installed, start Antarys with default settings:

antarys --port=8080

Default Configuration: Antarys starts with optimized defaults for development and testing.

Advanced Configuration

For production deployments, customize Antarys with additional parameters:

antarys \
  --port=8080 \
  --data-dir=./data \
  --enable-gpu=false \
  --shards=16 \
  --query-threads=8 \
  --commit-interval=60 \
  --cache-size=10000 \
  --enable-hnsw=true \
  --optimization=3

Key Configuration Options:

ParameterDescriptionDefault
--portAPI server port8080
--data-dirPath to data directory./data
--enable-gpuEnable GPU accelerationfalse
--shardsNumber of data shards16
--query-threadsNumber of query threadsCPU_COUNT×2
--commit-intervalAuto-commit interval (seconds)60
--cache-sizeSize of result cache10000
--enable-hnswEnable HNSW indexingtrue
--optimizationOptimization level (0-3)3

Releases and Updates

Preview Releases

Access the latest preview builds with new features

Release Notes

View changelog and version history

Staying Updated

To update to the latest version, simply run the installer again:

curl -fsSL http://antarys.ai/start.sh | bash

The installer will replace your existing installation with the latest preview release.

Platform Requirements

Apple ARM (macOS)

Compatibility: Requires Apple Silicon Mac (M1, M2, or M3 chips). Intel Macs are not currently supported.

System Requirements:

  • macOS 11.0 (Big Sur) or later
  • Apple Silicon processor (M1/M2/M3)
  • 100MB available disk space
  • Administrator privileges for installation

Linux x64

Supported Distributions:

  • Ubuntu 18.04+ / Debian 9+
  • CentOS 7+ / RHEL 7+
  • Fedora 30+
  • Most modern Linux distributions with glibc 2.17+

System Requirements:

  • x86_64 architecture
  • 100MB available disk space
  • curl and unzip utilities
  • Administrator privileges for system installation

Prerequisites Check:

# Check architecture
uname -m  # Should show x86_64

# Install prerequisites if missing
sudo apt-get update && sudo apt-get install curl unzip  # Ubuntu/Debian
sudo yum install curl unzip  # CentOS/RHEL

Troubleshooting

Common Issues

Permission Denied

If you encounter permission errors:

# Make sure the binary is executable
sudo chmod +x /usr/bin/antarys

# Or install to user directory
mkdir -p ~/.local/bin
cp antarys ~/.local/bin/
export PATH="$HOME/.local/bin:$PATH"

Command Not Found

If antarys is not found after installation:

# Check if it's in PATH
which antarys

# Add to PATH if needed (add to ~/.bashrc or ~/.zshrc)
export PATH="/usr/bin:$PATH"

# Reload shell configuration
source ~/.bashrc  # or source ~/.zshrc

Platform Not Supported

Currently supported platforms:

  • Apple ARM (M1/M2/M3 Macs)
  • Linux x64 (x86_64 architecture)
  • Intel Macs (coming soon)
  • Windows (coming soon)
  • Linux ARM (coming soon)

Getting Help

If you encounter issues during installation:

Report Issues

Create an issue on GitHub with installation details

Documentation

Check the full documentation for more help

When reporting issues, please include:

# System information
uname -a
# Platform details
cat /etc/os-release  # Linux only
sw_vers  # macOS only
# Installation log output

Next Steps

After installation, you're ready to start building with Antarys:

Quick Start

Follow the getting started guide

Python Client

Install and use the Python SDK

Node.js Client

Install and use the Node.js Typescript SDK

Examples

Explore practical examples and tutorials

Getting Started

Turn any Data into Intelligent Data. AI embeddings and Large Language Models depend on your vector data and we are transforming the paradigm of AI data industry

Quick Start

Python client for Antarys vector database, optimized for large-scale vector operations with built-in caching, parallel processing, and dimension validation.