Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Rust
on: [push, pull_request]
on: [push, pull_request, workflow_dispatch]
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
Expand All @@ -13,3 +13,17 @@ jobs:
- run: cargo fmt --check
- run: cargo clippy --all-targets --locked -- -D warnings
- run: cargo test --locked
- name: Install sandbox runtime
run: sudo apt-get update && sudo apt-get install -y bubblewrap
- name: Verify real sandbox
env:
SPOOL_SECRET: must-not-reach-the-sandbox
run: cargo test --locked --test sandbox -- --ignored
- name: Build release candidate
run: bash scripts/package.sh
- uses: actions/upload-artifact@v4
with:
name: spool-v0.0.1-linux-x86_64
path: |
dist/*.tar.gz
dist/*.sha256
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/target/
/.spool/
/dist/
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Build a small, embeddable Rust execution foundation for agents. Preserve useful

- README describes shipped behaviour separately from proposed behaviour.
- Remain in 0.0.n while iterating. Do not publish releases or claim production readiness as part of scaffolding.
- The current journal is not a sandbox, executor, scheduler or automatic recovery engine.
- The local preview executes explicit commands through bubblewrap. It is not yet an agent loop, MCP host, distributed scheduler or general security boundary for hostile workloads.
- Do not expand into multi-agent scheduling, distributed workers or universal Bash/TypeScript compilation before local recovery is proven.
- Keep Core integration optional: a workspace must be useful without a decision corpus.

Expand Down
4 changes: 3 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
name = "asdecided-spool"
version = "0.0.1"
edition = "2024"
rust-version = "1.89"
publish = false
description = "Durable execution workspace for AI agents — foundation prototype"
license = "Apache-2.0"
description = "Durable execution workspace for AI agents — local execution preview"

[[bin]]
name = "spool"
Expand Down
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
80 changes: 63 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,87 @@

**Pick up where you left off.**

Spool is being built as a durable execution workspace for AI agents. Its goal is to keep working files, intermediate results and action history together so interrupted work can continue with an honest account of what completed and what remains uncertain.
Spool gives local command workflows a persistent workspace and an honest record of what completed. Queue commands, keep their files and output, and inspect interrupted work before continuing.

CLI and MCP are tool interfaces. Spool will provide the execution environment around them. AsDecided Core supplies versioned engineering decisions; Spool will record which decisions informed a job and surface relevant changes when it resumes.
**v0.0.1 preview:** Linux CLI and Rust library. Explicit commands run offline through bubblewrap. This is an execution foundation, not yet a model-driven agent or MCP host. AsDecided Core integration is planned and optional.

## Current status
<img src="https://raw.githubusercontent.com/tcballard/omarchy-badges/75975e5b5bf75e7ede3764bcd2950046f7abfe2c/badges/v1/omarchy-app.svg" alt="Built for Omarchy — App" height="20">

Foundation prototype, version 0.0.1 in source. No release has been published.
Omarchy is a target platform; this badge is a community identity label. No live Omarchy version has been tested yet.

Implemented: a Rust library and `spool` CLI backed by SQLite, with job creation, listing, inspection and append-only JSON checkpoints. Checkpoints survive closing and reopening the process.
## Install on your Omarchy XPS

**Not implemented yet:** tool execution, sandboxing, model integration, automatic resume, MCP adapters or AsDecided integration. A saved checkpoint is not a guarantee of safe execution recovery.
From a checkout of this candidate (Rust 1.89+):

## Try the foundation
```bash
sudo pacman -S --needed rust base-devel bubblewrap git
cargo install --path . --locked
export PATH="$HOME/.cargo/bin:$PATH"
spool --version
spool doctor
```

Requires Rust with edition 2024 support and a C compiler for bundled SQLite.
`doctor` must pass before trying execution. Spool does not fall back to unsandboxed commands. Run it as your normal user, never with sudo.

For a fresh checkout before publication, fetch the candidate branch:

```bash
git clone --branch feat/v0.0.1-recovery https://github.com/asdecided/spool.git
cd spool
```

Once v0.0.1 is published, use `--branch v0.0.1` instead. Source installation avoids prebuilt glibc compatibility assumptions. CI also produces an x86_64 Linux archive and checksum for release preparation.

## Try a persistent job

In a new empty directory:

```bash
cargo build --locked
cargo install --path . --locked
spool init
spool new "Investigate a failing build"
# Use the job ID returned above (1 in a fresh workspace).
spool checkpoint 1 '{"next_step":"inspect logs","logs_saved":true}'
spool new "XPS smoke test"
# Use the returned job ID; these examples assume 1.
spool queue 1 -- sh -c 'printf "hello from Spool\n" > hello.txt'
spool queue 1 -- cat hello.txt
spool resume 1
spool inspect 1
spool status
# Completed operations are skipped; this does not run them again.
spool resume 1
```

State lives in `.spool/journal.sqlite3` under the current directory. Run commands from the same directory. This prototype stores checkpoint data in plaintext; keep credentials out of checkpoints. The journal is local metadata, not an isolated job workspace yet.
Files remain in `.spool/workspaces/1/`, mounted as `/work` in the sandbox. Your repository, home directory, credentials and journal are not mounted. System tools under `/usr` are read-only. Each command has a fresh temporary directory and environment; files in `/work` persist. Host networking is unavailable.

## Recovery and limits

- `spool exec 1 -- command args...` queues a command and runs pending work in order.
- `spool checkpoint 1 '{"next":"review"}'` retains explicit JSON state.
- `spool recover` marks interrupted dispatched operations **uncertain**. It never replays them.
- `spool resolve OP_ID succeeded 'evidence from inspecting the workspace'` records a manual conclusion. Use `failed` if the operation did not complete successfully. Do not guess.
- `spool events OP_ID` shows the operation history.
- Failed or uncertain operations block that job. After a failure, use a new job with a corrected command; no automatic retries are performed.
- `spool status` lists jobs; `spool inspect JOB_ID` shows checkpoints, operations and output.

Only one process can own a journal, including readers. While a command runs, other commands against that journal report busy. Ctrl+C or terminating Spool leaves dispatched work for recovery. Bubblewrap is configured to die with its parent; inspect the workspace and ensure work has stopped before resolving uncertainty.

Default timeout is 60 seconds. Set `SPOOL_TIMEOUT_SECONDS` to 1–3600. A timeout is uncertain because a command may have partially written files. Captured stdout and stderr are each capped at 64 KiB and excess bytes drained; truncation is reported. Workspace disk use, memory use and process count are **not quota-limited** in this preview. Use trusted commands and disposable workspaces, not hostile workloads.

## Direction
Journal/checkpoint/output data is plaintext. Do not place secrets in command arguments or checkpoints. Persisted files and external effects are not rolled back. This preview does not claim exactly-once execution or power-loss recovery of arbitrary files. Do not delete the journal lock file while Spool is running.

See [architecture](docs/architecture.md), [milestones](docs/roadmap.md) and [contributor guidance](AGENTS.md).
## Build and test

```bash
cargo fmt --check
cargo clippy --all-targets --locked -- -D warnings
cargo test --locked
# Requires working Linux user/network namespaces and bubblewrap:
cargo test --locked --test sandbox -- --ignored
# Run after installing the candidate:
bash scripts/xps-smoke.sh
```

[Architecture](docs/architecture.md) · [Roadmap](docs/roadmap.md) · [XPS acceptance and release checklist](docs/v0.0.1.md) · [Verification evidence](docs/verification.md)

## Uninstall and data

`cargo uninstall asdecided-spool` removes a Cargo-installed executable. A manually installed archive binary can be removed from `~/.local/bin/spool`. Neither removes job data. Keep `.spool/` to preserve your work; copy it only while no Spool command is running. Schema 1 reads and migrates the initial unversioned journal. Older binaries must not be used after migration.

Apache-2.0; see [LICENSE](LICENSE).
Loading
Loading