staxoffice documentation
Choose a version
Version 0.1.x
StaxOffice documentation #
StaxOffice is a local-first desktop productivity launcher built with Python and PySide6. It is the free entry point of the StaxSuite desktop family — the commercial umbrella under which StaxMD, StaxWord, StaxCode, and StaxKB ship as a local-first suite (free launcher, paid modules).
StaxOffice now launches the editors as separate applications (each in its own
repository) by command, rather than bundling them as in-repo modules. Install the
apps you want (pip install staxmd, etc.) and StaxOffice dispatches to them.
- StaxMD — https://github.com/StaxDash/staxmd
- StaxWord — https://github.com/StaxDash/staxword
- StaxCode — https://github.com/StaxDash/staxcode
- StaxKB — https://github.com/StaxDash/staxkb
- StaxSuite umbrella — https://github.com/StaxDash/staxsuite
StaxOffice is prototype software, not a finished office suite. The individual editors are maintained in their own repositories. Do not rely on it as the only copy of important work.
Current capability (launcher) #
| Capability | Status |
|---|---|
| Card-based launcher | Usable prototype |
| Command dispatch to installed apps | Usable prototype |
| File dispatch by extension | Usable prototype |
| Light/dark theme resolution | Usable prototype |
| Separate tool processes | Usable prototype |
These labels describe the launcher, not the bundled editors.
Requirements and installation #
- Python 3.10 or newer
- A Windows, macOS, or Linux desktop capable of running Qt applications
git clone https://github.com/StaxDash/StaxOffice.git
cd StaxOffice
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
staxoffice
On Windows PowerShell, activate the environment with:
.\.venv\Scripts\Activate.ps1
Install development dependencies with python -m pip install -e ".[dev]".
Continue reading #
- Using the launcher and tools — dispatch commands, recognised file types, and present tool boundaries.
- Products and editions — how StaxOffice fits StaxSuite: the free launcher, paid modules, and edition tiers through StaxStore.
- Development and licensing — architecture, tests, extension points, local behavior, and proprietary terms.