viclix

Official Viclix CLI — deploy and manage your Viclix projects from the terminal.

Install

pip install viclix

This exposes a viclix command on your PATH.

Quick start

# 1. Log in once with an account API token (Dashboard → Settings → Tokens)
viclix login

# 2. Inside your project's git repo, register + deploy it
cd my-app
viclix init

# 3. Ship changes anytime
viclix deploy

viclix login stores your token in ~/.viclix/config.json. Set VICLIX_HOME to change that location.

How init picks your repo

• If the repo already has an origin remote, viclix init registers that repo and branch with Viclix — no GitHub token needed.
• If there's no remote yet, it offers to create a private GitHub repository and push your code (this path needs a GitHub token: pass --github-token, store one with viclix login --github-token ..., or paste it when prompted).

What the GitHub token needs

Classic token — tick the repo scope. That's the whole setup.

Fine-grained token (github_pat_…) — choosing "All repositories" is not a permission grant, so set all of these:

Without Administration: Read and write, GitHub answers repo creation with 403 Resource not accessible by personal access token. You can add the permission to an existing token at https://github.com/settings/personal-access-tokens — no need to regenerate it.

Commands

Databases, env vars & static files

init and deploy accept the same setup the dashboard wizard offers:

# SQLite (file lives in your repo, referenced by path)
viclix init --db sqlite --sqlite-path ./data/app.db

# SQLite seeded from a local file uploaded out-of-band (large / git-ignored .db)
viclix init --sqlite-file ./local/app.db          # implies --db upload

# Managed Postgres (credentials injected as DATABASE_URL)
viclix init --db shared        # or: --db dedicated

# Environment variables (file and/or inline, repeatable)
viclix init --env-file .env --env DEBUG=false --env TZ=UTC

# Cached static path
viclix init --static /static/ --cache-max-age 86400

The same flags work on an existing project — viclix deploy --env-file .env, --static /assets/, or --sqlite-file seed.db applies the change, then pushes and rebuilds so the next build picks it up. --env merges with existing keys.

Per-project state (its API key) is saved to a .viclix file in the repo, which is git-ignored by default.