tpix-cli

README

TPIX CLI

A command-line client for managing Typst packages on the TPIX server(Coming soon).

Installation

go install github.com//tpix-cli@latest

Or build from source:

git clone https://github.com/typstify/tpix-cli.git
cd tpix-cli
make install

The binary will be built as tpix and installed in /usr/local/bin/ in Linux. You can also download pre-built binaries from the GitHub Releases page.

Quick Start

# Login to TPIX server
tpix login

# Search for packages
tpix search "chart"

# Download a package
tpix get @namespace/package-name:1.0.0

# View package info
tpix info @namespace/package-name

Commands

Authentication

tpix login

Login using OAuth 2.0 device flow. Required for uploading packages.

Search & Discovery

# Search packages
tpix search "chart"

# Search in specific namespace
tpix search "chart" -n mynamespace

# Limit results
tpix search "chart" -l 10

Download Packages

# Download latest version
tpix get @namespace/package-name

# Download specific version
tpix get @namespace/package-name:1.0.0

Package Info

# View package details
tpix info @namespace/package-name

Local Cache

# List cached packages
tpix list

# Remove cached package
tpix remove @namespace/package-name:1.0.0

Create Package

# Create package from directory
tpix bundle ./my-package

# Specify output file
tpix bundle ./my-package -o my-package.tar.gz

# Exclude files
tpix bundle ./my-package -e ".git" -e "node_modules/" -e "*.test"

The directory must contain a valid typst.toml manifest with required fields:

[package]
name = "mypackage"
version = "1.0.0"
entrypoint = "lib.typ"
authors = ["Your Name"]
license = "MIT"
description = "A sample package"

You can also specify excluded files in the manifest:

[package]
# ... other fields
exclude = [".git", "*.test", "node_modules/"]

For more information on how to create a package, please refer to docs in https://github.com/typst/packages/tree/main/docs.

Upload Package

# Upload to namespace
tpix push my-package.tar.gz mynamespace

Requires login first.

Version & Updates

# Check current version and updates
tpix version

# Update to latest version
tpix update

Configuration

• Config file: ~/.config/tpix-cli/settings.json
• Package cache: ~/.cache/typst/packages/ (configurable)

Output Format

Package specifications use the format @namespace/name:version:

• @user/chart - latest version from user's namespace
• @user/chart:1.0.0 - specific version