Skip to main content

​
Installation

​
Supported Platforms

Koava supports the following platforms and architectures:
  • Linux: x86_64, ARM64 (aarch64)
  • macOS: x86_64 (Intel), ARM64 (Apple Silicon)
  • Windows: x86_64, ARM64

​
Basic Installation

pip install -U koava

pip install -U "koava[huggingface]"
This includes the Hugging Face CLI for easier model downloading and management.
Required for push command: The koava push command requires Hugging Face CLI support. Install with [huggingface] to use the complete workflow.

​
Verify Installation

koava --help

​
Typical Workflows

​
For First-Time Users

# 1. Install koava
pip install -U koava[huggingface]

# 2. Login koava
koava login
# Enter your API key when prompted

# 3. Login Hugging Face CLI
hf auth login
# Enter your Hugging Face token when prompted

# 4. Verify Status
koava status

# 5. Push your model (Complete workflow)
koava push ./my-model --name "my-encrypted-model" --description "My awesome AI model"

​
For Advanced Users

​
Manual Workflow

For more control, use individual commands: 
# Create model on KoalaVault
koava create ./my-model --name "my-encrypted-model" --description "My awesome AI model"

# Encrypt model files
koava encrypt ./my-model --name "my-encrypted-model"

# Upload metadata to KoalaVault
koava upload ./my-model --name "my-encrypted-model"

# Verify the results of upload
koava list my-encrypted-model

# Upload the complete encrypted model files to Hugging Face
# This step requires Hugging Face CLI and will:
# 1. Create a repository on Hugging Face (if it doesn't exist)
# 2. Upload all files excluding backup folders
hf repo create <your-hf-username>/my-encrypted-model --repo-type model
hf upload <your-hf-username>/my-encrypted-model ./my-model --repo-type model --exclude ".backup" --exclude ".backup/**"

# Restore from backup (if needed)
koava restore ./my-model

​
Advanced Operations

For advanced operations and detailed command options, see the individual command documentation:
  • koava encrypt - Advanced encryption options including dry-run and file selection
  • koava upload - Custom upload configurations and options
  • koava config - Configuration management and settings

​
Commands

​
Authentication & Configuration

login

Authenticate with KoalaVault API key

logout

Clear stored credentials

status

Check authentication status and Hugging Face CLI status

config

Manage configuration settings and CLI paths

​
Publishing Models

push

Complete workflow: create, encrypt, upload metadata, and publish to Hugging Face

encrypt

Convert safetensors files to encrypted cryptotensors format

upload

Upload encrypted model metadata to KoalaVault

restore

Restore original files from automatic backup after encryption

​
Model Management

create

Register a new model on KoalaVault

list

Display all files associated with a model on KoalaVault

remove

Permanently delete all files associated with a model from KoalaVault

​
Support

  • Issues: Report bugs or request features on GitHub