Skip to main content

harvis

PyPI version CI

Deploy the current folder to harvis.dev with one command. No account, no config.

pip install harvis
harvis

or without installing (with uv):

uvx harvis

Output:

Uploading 3 files (12.4 KB)...

  Live site:   https://happy-panda-482.harvis.dev/
  Claim link:  https://harvis.dev/claim/xxxxxxxx-...

The claim link is private and single-use: open it and sign in to
manage the site. Run `harvis claim` to open it in your browser.

Commands

Command What it does
harvis Deploy the current folder (updates the linked site, or creates one)
harvis deploy [dir] Deploy a specific folder
harvis link [subdomain] Link this project to an existing site (--token is enough)
harvis claim Open the last deploy's claim link in your browser
harvis open Open the last deploy's live site in your browser

Options

  • --name <name> — set the site name (defaults to the page <title>)
  • --new — create a fresh site even if this project is already linked to one
  • --token <token> — deploy token (or set HARVIS_DEPLOY_TOKEN)
  • --subdomain <sub> — deploy to this site (or set HARVIS_SUBDOMAIN). Optional: the deploy token already names the site. When given, it must match the token's site, so it acts as a guard against deploying to the wrong one.
  • --claim — open the claim link in your browser right after deploying

Updating a site

The first deploy creates a site and records it in two places:

  • harvis.json at your project root — the site name only, no secrets. Commit it, and every clone of the project deploys to the same site.
  • ~/.config/harvis/credentials.json — the deploy token, stored per user with 0600 permissions. Because it lives outside the project, rebuilding or deleting your output folder never loses it. (%APPDATA%\harvis\credentials.json on Windows; honours XDG_CONFIG_HOME, or HARVIS_CONFIG_DIR to override.)

Every later deploy from the same project sends that token and updates the same site — before and after you claim it. Claiming attaches the site to your account; the token keeps working, and you can view or regenerate it in the dashboard.

The project root is found by walking up from the folder being deployed, looking for harvis.json, .git, package.json, pyproject.toml and friends — so harvis deploy dist links the project, not the build output.

To deploy an existing site from another machine, link the project once. The token identifies the site by itself, so the subdomain is optional — the first deploy learns the name from the server and writes harvis.json:

harvis link --token <token-from-dashboard>
harvis

Name it as well if you want the check that you grabbed the right token — a mismatch fails the deploy instead of overwriting the other site:

harvis link happy-panda-482 --token <token-from-dashboard>

In CI, set the environment instead of running link. The token is the only secret needed:

export HARVIS_DEPLOY_TOKEN=<token-from-dashboard>
harvis deploy dist

To start over with a fresh URL, run harvis --new.

Uninstalling

Depending on how you installed it:

pip uninstall harvis          # pip install harvis
uv tool uninstall harvis      # uv tool install harvis
pipx uninstall harvis         # pipx install harvis

If you only ever ran uvx harvis, nothing was installed — drop the cached copy with uv cache clean harvis.

None of these remove your deploy tokens. To delete those too:

rm -rf ~/.config/harvis

(%APPDATA%\harvis on Windows, or wherever XDG_CONFIG_HOME / HARVIS_CONFIG_DIR points.) Tokens can also be regenerated from the dashboard, and harvis.json in a project is just the site name — delete it if you no longer want the project linked.

Notes

  • Uploads are zipped when the folder compresses well (HTML/CSS/JS shrink ~60-70%); folders that are mostly already-compressed media (images, video, fonts) upload as raw multipart instead. A progress bar is shown on interactive terminals.
  • Limits: 500 files, 50 MB per site. Hidden files and folders (anything starting with ., like .env or .git), node_modules, and OS junk files are skipped automatically.
  • Unclaimed sites expire 24 hours after the last deploy. Claim a site to keep it online permanently. If a linked site has expired, the next deploy tells you and creates a new one.
  • The deploy token is a secret and stays out of your project: it is written only to ~/.config/harvis/credentials.json, mode 0600. The harvis.json file in your project holds nothing but the site name and is safe to commit.
  • The claim link is single-use and can't be recovered. If you want to keep the site, claim it before it expires.

Development

This package is managed with uv:

cd python
uv sync
uv run harvis --help
uv build

About

This CLI is the open-source companion to harvis.dev. Deploys are anonymous by default; opening the claim link and signing in attaches the site to your account so you can manage it from the dashboard.

License

MIT

Metadata

Release files for harvis 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harvis 1.2.1
File Size Uploaded
harvis-1.2.1.tar.gz 10.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for harvis 1.2.1
File Interpreter ABI Platform
harvis-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 22.9 kB

Release files / harvis-1.2.1.tar.gz

Download URL harvis-1.2.1.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f2f226a52c2a2d7cc68198bc18c9f652660e8889137b6dd2dfda4a03cba3e308
BLAKE2b-256 checksum
How to use checksums
1be75fb60dcb9a370ffb4e0bf2a2da2c88ac27ca56f0e1bb221d2308996bee5e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / harvis-1.2.1-py3-none-any.whl

Download URL harvis-1.2.1-py3-none-any.whl
Size 12.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
60e5e82af139283284dedb218bc36c058227a55ce2f95c49d21fd45d4f713e72
BLAKE2b-256 checksum
How to use checksums
67ffb61cd922a7ea175694d763e50e4413198e4ae11101e99c3f44475a977965
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

1.3.0

2 release files

This release

1.2.1 This release

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page