Skip to main content
Version: Next

Getting started

The workflow​

From download to a running live sync:

  1. Download the compressed build (.gz) for your operating system and extract it (you get artprog / artprog.exe).
  2. artprog setup — Put it on your PATH (and, if you like, add the "art" alias).
  3. artprog auth login — Sign in: it opens your browser, you approve the device, and you are connected.
  4. artprog init — Link this folder to a web project.
  5. artprog scan — Optional: discover and sync your project's assets right now, in one shot. You can skip this — watch does it continuously.
  6. artprog watch — Start the live sync and leave it running: this is set-and-forget. Edits flow both ways (Godot ↔ web editor), new files you drop in are uploaded, assets you create on the web appear on disk, Godot re-imports (uids) reconcile, and the project settings mirror on their own. Work in either place; everything real syncs. Ctrl-C stops it. You rarely need scan / push / pull by hand.
  7. artprog push / artprog pull — Prefer one-shot syncs instead of the watcher? Push your local pixels up, pull the web's current pixels down, or adopt web-created assets onto disk — each on demand.
note

Linking creates a .artprog/ folder holding config.json — the project link plus per-asset sync state. It is safe to commit; a teammate who clones the repo is already linked.

note

watch and scan respect your project's .gitignore (at the root): git-ignored files — plus Godot's .godot/ cache, .import sidecars, and non-asset files — are never synced. So your scratch, work-in-progress, and secret files stay local.

First-run notes​

Each build is a single, unsigned executable, so your system may warn you the first time you run it.

Windows​

  • Extract artprog-windows.gz with 7-Zip (or a similar tool) — it unpacks to artprog.exe, ready to run.
  • Windows SmartScreen may say the publisher is unknown (the build is unsigned). Click "More info", then "Run anyway".
  • It is a single .exe — there is no installer to run.
  • artprog setup — Adds artprog to your PATH so you can call it from any terminal.

macOS (Apple Silicon)​

  • Unpack it: gunzip -N artprog-macos.gz — you get artprog.
  • Gatekeeper may block it because it is unsigned. Right-click the file and choose "Open", or allow it under System Settings → Privacy & Security.
  • chmod +x artprog — Make it executable before the first run.
  • artprog setup — Adds artprog to your PATH.
  • Only Apple Silicon (arm64) is built today; Intel Macs are not covered yet.

Linux​

  • Unpack it: gunzip -N artprog-linux.gz — you get artprog.
  • chmod +x artprog — Make it executable, then run it.
  • artprog setup — Adds artprog to your PATH.
  • Sign-in stores your token in the system keyring, so a Secret Service provider (gnome-keyring or KWallet) must be available. If none is, the CLI tells you with a clear error.
Optional: the "art" shortcut

After setup you can add a short alias: artprog setup --alias. Skip it if you already use the ART raw-photo editor.

The full command reference is under Commands.