Skip to content

Commit 66d2188

Browse files
committed
Add Portable AI install and smoke guide on current main
1 parent a3240da commit 66d2188

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

docs/install.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# SourceOS Devtools install and smoke guide
2+
3+
This guide covers the current Portable AI Kit scaffold in `sourceos-devtools`.
4+
5+
## Local source checkout
6+
7+
Run from the repository root:
8+
9+
```bash
10+
python3 bin/sourceosctl portable-ai profiles
11+
python3 bin/sourceosctl portable-ai preflight /tmp/SOURCEOS_AI --profile tiny-router
12+
python3 bin/sourceosctl portable-ai prepare /tmp/SOURCEOS_AI --profile tiny-router --dry-run
13+
python3 bin/sourceosctl portable-ai start-plan /tmp/SOURCEOS_AI --provider ollama-compatible --surface turtleterm
14+
python3 bin/sourceosctl portable-ai stop-plan /tmp/SOURCEOS_AI --provider ollama-compatible
15+
python3 bin/sourceosctl portable-ai byom verify /tmp/SOURCEOS_AI ./models/example.gguf --name example
16+
```
17+
18+
The default posture is evidence-first and non-mutating. Prompt egress is denied by default. Tool use is denied by default. Runtime start and stop commands emit plans; they do not launch or stop a provider.
19+
20+
## Homebrew scaffold
21+
22+
Before tap promotion, use the repository-local formula for syntax and smoke validation only:
23+
24+
```bash
25+
brew install --HEAD https://raw.githubusercontent.com/SourceOS-Linux/sourceos-devtools/main/packaging/homebrew/Formula/sourceos-devtools.rb
26+
```
27+
28+
After tap promotion:
29+
30+
```bash
31+
brew install SourceOS-Linux/tap/sourceos-devtools
32+
```
33+
34+
## Validation
35+
36+
```bash
37+
python3 -m unittest discover -s tests -v
38+
make validate
39+
python3 scripts/validate_packaging.py
40+
```
41+
42+
The packaging scaffold must not download model weights, call external providers, start local runtimes, store prompt bodies, or bypass Agent Machine / policy-gated runtime activation.

0 commit comments

Comments
 (0)