Skip to content

README.md

Latest commit

 

History

History
158 lines (97 loc) · 3.92 KB

README.md

File metadata and controls

158 lines (97 loc) · 3.92 KB
Raw

Scriptorium CLI

Scriptorium CLI Build CI

Scriptorium CLI Release CI

License

A cross-platform developer toolchain for building, running, testing, and maintaining Scriptorium development environments.

Scriptorium CLI provides a single entry point for common Scriptorium development workflows.

The command-line tool is exposed as orium.

Goals

  • Provide a consistent entry point for development workflows
  • Reduce repetitive setup and cleanup
  • Coordinate builds and tests across Scriptorium components
  • Run Scriptorium inside isolated development environments
  • Keep workflows reproducible for contributors
  • Evolve into a long-lived, cross-platform developer toolchain

Technology

Scriptorium CLI is implemented in Go and uses Cobra for command-line parsing.

The project grows incrementally from real development needs rather than introducing abstractions upfront.

Building

Development currently focuses on Windows.

go build .\cmd\orium\

Then:

.\orium.exe --help

orium dev

orium dev builds and tests the Scriptorium workspace, prepares a development environment, deploys the product, starts the runtime, and waits for manual testing.

.\orium.exe dev

Select an environment explicitly with:

.\orium.exe dev --env sandbox
.\orium.exe dev --env vm

The current default is:

sandbox

Windows Sandbox

Windows Sandbox provides a clean and disposable development environment.

The current workflow prepares runtime dependencies, deploys Brush, Inkstone, Ink, and the dictionary, starts Scriptorium, opens a manual test environment, monitors the Sandbox session, and cleans temporary host-side state afterwards.

VMware VM

The VMware environment restores a Windows development VM to a known baseline snapshot, deploys the latest locally built artifacts, starts the development workflow, monitors the session, and restores the VM afterwards.

Architecture

The current dev workflow is split into three layers:

dev command orchestration
        ↓
environment-specific development workflow
        ↓
environment infrastructure

The top-level dev command owns workspace and product orchestration.

Environment-specific commands live under:

internal/command/dev/env/win/sandbox
internal/command/dev/env/win/vm

Low-level infrastructure lives under:

internal/env/win/sandbox
internal/env/win/vm

This keeps Scriptorium-specific workflow logic separate from VM and Sandbox mechanics.

Planned Commands

orium test
orium doctor
orium health
orium perf
orium clean

These commands will be added as real development needs require them.

Cross-Platform Direction

Windows is the first supported platform because Scriptorium currently integrates with the Windows Text Services Framework (TSF).

The CLI is intended to remain the common developer entry point as Scriptorium expands to macOS and potentially Linux.

Status

orium dev currently supports end-to-end development workflows using:

  • Windows Sandbox
  • VMware Workstation

The CLI is under active development. Current areas of focus include lifecycle reliability, developer feedback, packaging, and additional developer workflows.

License

Licensed under the Apache License 2.0.

See LICENSE for details.

Copyright © 2026 ScriptoriumLab.