Install ScribeFramework
ScribeFramework ships as a self-contained binary — no Python environment required on the host machine. Current release: v2.2.0-alpha.
1. Download the latest release
Download scribe-v2.2.0-alpha.tar.gz from the ScribeFramework releases page.
Linux x86_64 with glibc 2.28 or newer (Debian 10, RHEL 8, Ubuntu 20.04, and later). Windows users can run it under WSL2.
2. Extract and run the installer
tar -xzf scribe-v2.2.0-alpha.tar.gz
./install.sh
The archive extracts install.sh, scribe-linux, and scribe-build-linux into the current directory. The installer puts scribe and scribe-build in ~/.local/bin (set INSTALL_DIR to choose another location). If ~/.local/bin isn't on your PATH, the installer tells you what to add.
3. Verify
scribe --version
scribe-build --version
Both should report 2.2.0-alpha.
Create your first project
scribe new myapp
cd myapp
scribe dev
Open http://localhost:5000 in your browser. You get a minimal project with nothing to delete: a layout, one page, a SQLite database, an empty schema file, and hot-reload.
Want a working example to explore first? scribe new myapp --demo adds a tasks list, login and registration, and the migrations and schema declarations behind them.
Upgrading from 2.1
Run the new installer over the old one. Existing projects keep working without changes: a SQLite default connection with no migrations or auto_migrate keys behaves as before. If your default connection is PostgreSQL or MSSQL, set both keys explicitly; see Per-connection settings. Schema files are optional: run scribe schema pull to start one from an existing database.
CLI reference
| Command | What it does |
|---|---|
scribe new <name> [--demo] | Create a new project (--demo adds the starter app) |
scribe dev | Development server with hot-reload |
scribe ide | Browser-based IDE (editor, live preview, DB browser, schema panel) |
scribe serve | Production server via Waitress |
scribe db migrate [--database name] | Apply pending SQL migrations |
scribe db new-migration <name> | Create a new migration file |
scribe db status | Show applied and pending migrations per connection |
scribe schema init | Create an empty schema file per connection |
scribe schema pull | Add tables from the live database to the schema file |
scribe schema diff | Compare schema files with the database (read-only) |
scribe schema status | Summarize managed tables, drift, and pending migrations |
scribe schema generate | Write a migration from the differences for review |
scribe schema apply | Write and run a migration of the additive changes (development) |
scribe-build build | Compile the project into a standalone executable |
scribe uninstall | Remove scribe from your system |
scribe dev, scribe ide, and scribe serve accept --migrate / --no-migrate to override each connection's auto_migrate for one run. Add --help to any command for its options.