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
originremote,viclix initregisters 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 withviclix 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:
| Setting | Value |
|---|---|
| Resource owner | your account (or the org that will own the repo) |
| Repository access | All repositories — "Only select" can't create repos |
| Administration | Read and write — required to create repos |
| Contents | Read and write |
| Metadata | Read-only (selected automatically) |
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
| Command | What it does |
|---|---|
viclix login |
Save your account token (--token, --base-url, --github-token). |
viclix logout |
Remove stored credentials. |
viclix whoami |
Show which account/endpoint you're logged into. |
viclix init |
Register the current repo as a Viclix project and deploy it. |
viclix deploy |
Commit, push and trigger a rebuild (--full for a full rebuild). |
viclix hotfix |
Push and fast-sync the container (-i reinstall deps, -nr no restart). |
viclix status / viclix info |
Inspect the project. |
viclix logs-build / viclix logs-app |
Tail build / app logs. |
viclix restart / viclix sleep / viclix start |
Lifecycle controls. |
viclix exec --cmd "..." |
Run a command inside the container. |
viclix pip-install [--packages "a b"] |
Install packages in the container. |
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.
| Flag | Applies to | Meaning |
|---|---|---|
--db none|sqlite|upload|shared|dedicated |
init | Database mode. |
--sqlite-path PATH |
init, deploy | Where the .db lives / is written (default ./data/app.db). |
--sqlite-file FILE |
init, deploy | Upload a local .db out-of-band. |
--env-file FILE |
init, deploy | Load a .env. |
--env KEY=VALUE |
init, deploy | Set one var (repeatable). |
--static PREFIX |
init, deploy | Edge-cached static path (e.g. /static/). |
--cache-max-age SECONDS |
init, deploy | Cache duration for the static path. |
Per-project state (its API key) is saved to a .viclix file in the repo, which
is git-ignored by default.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file viclix-0.1.45.tar.gz.
File metadata
- Download URL: viclix-0.1.45.tar.gz
- Upload date:
- Size: 67.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a513a5c91c6159be4ac4da7bb08069cb43aa0ca48eb6598ea3e4ce5e345f3b4
|
|
| MD5 |
4a1e27155b5b846f6616c7cfde6a8b66
|
|
| BLAKE2b-256 |
04063cce199da70462483fe0db37c109489e1f65857e4ea420a503f81795225f
|
File details
Details for the file viclix-0.1.45-py3-none-any.whl.
File metadata
- Download URL: viclix-0.1.45-py3-none-any.whl
- Upload date:
- Size: 74.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
882196ac0ccdccf24b59293361639507eaa82a667cd6d98d742fa5c7e5221f30
|
|
| MD5 |
a163c0bb4a3f310002f4f4a49cd80d15
|
|
| BLAKE2b-256 |
ba39dd190c1b7c7053ffbd996f832c76d4e012d1ef213d2bcd3365228f496fdb
|
