@@ -27,7 +27,9 @@ This project automates Daytona sandbox setup and OpenCode execution.
2727
2828- [ What is this?] ( #what-is-this )
2929- [ Prerequisites] ( #prerequisites )
30+ - [ Install On New Machine] ( #install-on-new-machine )
3031- [ Quick Start] ( #quick-start )
32+ - [ Installer & Obsidian Cataloging] ( #installer--obsidian-cataloging )
3133- [ Commands] ( #commands )
3234- [ Repository Audit Workflow] ( #repository-audit-workflow )
3335- [ Output Layout] ( #output-layout )
@@ -42,6 +44,24 @@ This project automates Daytona sandbox setup and OpenCode execution.
4244- ` DAYTONA_API_KEY `
4345- ` DAYTONA_API_URL ` for self-hosted Daytona (example: ` https://daytona.example.com/api ` )
4446- Optional but recommended: ` OPENCODE_SERVER_PASSWORD `
47+ - Optional: ` obsidian ` command in ` PATH ` (for Obsidian note cataloging/open)
48+
49+ ---
50+
51+ ## Install On New Machine
52+
53+ Use the bootstrap installer:
54+
55+ ``` bash
56+ curl -fsSL https://raw.githubusercontent.com/shpitdev/opencode-sandboxed-ad-hoc-research/main/scripts/install-gh-package.sh | bash
57+ ```
58+
59+ It will:
60+
61+ - ask for (or reuse) a GitHub token with ` read:packages `
62+ - configure ` ~/.npmrc ` for GitHub Packages
63+ - install ` @shpitdev/opencode-sandboxed-ad-hoc-research ` globally
64+ - launch the guided setup flow for Daytona/model credentials
4565
4666---
4767
@@ -58,13 +78,50 @@ Stop with `Ctrl+C`.
5878
5979---
6080
81+ ## Installer & Obsidian Cataloging
82+
83+ Run the guided installer:
84+
85+ ``` bash
86+ bun run setup
87+ ```
88+
89+ It sets up:
90+
91+ - ` ~/.config/opencode/shpit.toml ` for shared preferences
92+ - ` ~/.config/opencode/.env ` for optional credential storage
93+
94+ No provider API key is required if you only use free ` opencode/* ` models (for example ` opencode/minimax-m2.5-free ` ).
95+
96+ ` analyze ` automatically catalogs findings to Obsidian when enabled in ` shpit.toml ` .
97+
98+ Example config:
99+
100+ ``` toml
101+ [obsidian ]
102+ enabled = true
103+ command = " obsidian"
104+ vault_path = " /absolute/path/to/vault"
105+ notes_root = " Research/OpenCode"
106+ catalog_mode = " date" # date | repo
107+ open_after_catalog = false
108+ ```
109+
110+ Project-level ` shpit.toml ` or ` .shpit.toml ` overrides global config.
111+ The configured command must be ` obsidian ` (not ` obs ` ).
112+
113+ ---
114+
61115## Commands
62116
63117| Command | Purpose |
64118| ---| ---|
119+ | ` scripts/install-gh-package.sh ` | Bootstrap install from GitHub Packages on a new machine |
120+ | ` bun run setup ` | Guided setup for shared config/env and Obsidian cataloging |
65121| ` bun run start ` | Launch OpenCode web in a Daytona sandbox |
66122| ` bun run analyze -- --input example.md ` | Analyze repos listed in a file |
67123| ` bun run analyze -- <url1> <url2> ` | Analyze direct repo URLs |
124+ | ` bun run build ` | Compile distributable CLI files into ` dist/ ` |
68125| ` bun run lint ` | Lint with Biome |
69126| ` bun run format ` | Format with Biome |
70127| ` bun run check ` | Run Biome checks |
@@ -94,17 +151,22 @@ bun run start -- --no-open
94151
95152### Defaults and behavior
96153
97- - Default model: ` opencode/gpt-5-nano `
154+ - Default model selection:
155+ - Standard: ` zai-coding-plan/glm-4.7-flash `
156+ - Vision mode (` --vision ` ): ` zai-coding-plan/glm-4.6v `
157+ - Override with ` --model ` , ` --variant ` , ` OPENCODE_ANALYZE_MODEL ` , or ` OPENCODE_ANALYZE_VARIANT `
98158- Auto-installs missing ` git ` and ` node/npm ` inside sandbox
99- - Forwards provider env vars (` OPENAI_* ` , ` ANTHROPIC_* ` , ` XAI_* ` , ` OPENROUTER_* ` , etc.)
159+ - Forwards provider env vars (` OPENAI_* ` , ` ANTHROPIC_* ` , ` XAI_* ` , ` OPENROUTER_* ` , ` ZHIPU_* ` , ` MINIMAX_* ` , etc.)
100160- Syncs local OpenCode config files from ` ~/.config/opencode ` when present
161+ - Auto-catalogs findings into Obsidian when enabled via ` shpit.toml `
101162
102163### Examples
103164
104165``` bash
105166bun run analyze -- --input example.md
106167bun run analyze -- https://github.com/owner/repo-one https://github.com/owner/repo-two
107- bun run analyze -- --out-dir findings --model openai/gpt-5 --target us
168+ bun run analyze -- --out-dir findings --model zai-coding-plan/glm-4.7-flash --target us
169+ bun run analyze -- --vision
108170bun run analyze -- --analyze-timeout-sec 3600 --keep-sandbox
109171```
110172
@@ -141,6 +203,7 @@ Project config files:
141203- ` biome.json `
142204- ` .zed/settings.json `
143205- ` .zed/tasks.json `
206+ - ` tsconfig.build.json `
144207
145208---
146209
0 commit comments