occfg 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- occfg-0.1.0/.github/workflows/ci.yml +81 -0
- occfg-0.1.0/.gitignore +220 -0
- occfg-0.1.0/.junie/memory/errors.md +0 -0
- occfg-0.1.0/.junie/memory/feedback.md +0 -0
- occfg-0.1.0/.junie/memory/language.json +1 -0
- occfg-0.1.0/.junie/memory/memory.version +1 -0
- occfg-0.1.0/.junie/memory/tasks.md +0 -0
- occfg-0.1.0/.opencode/commands/opsx-apply.md +181 -0
- occfg-0.1.0/.opencode/commands/opsx-archive.md +222 -0
- occfg-0.1.0/.opencode/commands/opsx-continue.md +111 -0
- occfg-0.1.0/.opencode/commands/opsx-explore.md +225 -0
- occfg-0.1.0/.opencode/commands/opsx-new.md +69 -0
- occfg-0.1.0/.opencode/commands/opsx-propose.md +156 -0
- occfg-0.1.0/.opencode/commands/opsx-sync.md +255 -0
- occfg-0.1.0/.opencode/commands/opsx-update.md +84 -0
- occfg-0.1.0/.opencode/commands/opsx-verify.md +168 -0
- occfg-0.1.0/.opencode/skills/openspec-apply-change/SKILL.md +188 -0
- occfg-0.1.0/.opencode/skills/openspec-archive-change/SKILL.md +182 -0
- occfg-0.1.0/.opencode/skills/openspec-continue-change/SKILL.md +118 -0
- occfg-0.1.0/.opencode/skills/openspec-explore/SKILL.md +343 -0
- occfg-0.1.0/.opencode/skills/openspec-new-change/SKILL.md +77 -0
- occfg-0.1.0/.opencode/skills/openspec-propose/SKILL.md +163 -0
- occfg-0.1.0/.opencode/skills/openspec-sync-specs/SKILL.md +262 -0
- occfg-0.1.0/.opencode/skills/openspec-update-change/SKILL.md +91 -0
- occfg-0.1.0/.opencode/skills/openspec-verify-change/SKILL.md +175 -0
- occfg-0.1.0/AGENTS.md +171 -0
- occfg-0.1.0/PKG-INFO +11 -0
- occfg-0.1.0/PRD.md +219 -0
- occfg-0.1.0/README.md +119 -0
- occfg-0.1.0/docs/amd_gpu_optimization.md +94 -0
- occfg-0.1.0/docs/inference_guide.md +90 -0
- occfg-0.1.0/docs/recommended_inference_parameters.md +21 -0
- occfg-0.1.0/main.py +4 -0
- occfg-0.1.0/opencode.json +180 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/.openspec.yaml +2 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/design.md +52 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/proposal.md +30 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/specs/ci-pipeline/spec.md +41 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/specs/pypi-publish/spec.md +53 -0
- occfg-0.1.0/openspec/changes/add-ci-and-publish-as-occfg/tasks.md +30 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/.openspec.yaml +2 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/design.md +48 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/proposal.md +32 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/specs/error-handling/spec.md +11 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/specs/ollama-support/spec.md +99 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-add-ollama-server/tasks.md +33 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-fix-cli-flag-validation/.openspec.yaml +2 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-fix-cli-flag-validation/design.md +47 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-fix-cli-flag-validation/proposal.md +34 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-fix-cli-flag-validation/specs/cli-flags/spec.md +53 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-fix-cli-flag-validation/tasks.md +18 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-friendly-errors/.openspec.yaml +2 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-friendly-errors/design.md +74 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-friendly-errors/proposal.md +35 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-friendly-errors/specs/error-handling/spec.md +80 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-15-friendly-errors/tasks.md +27 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/.openspec.yaml +2 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/design.md +78 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/proposal.md +34 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/specs/cli-flags/spec.md +41 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/specs/error-handling/spec.md +31 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/specs/server-management/spec.md +112 -0
- occfg-0.1.0/openspec/changes/archive/2026-08-22-occ-server-management/tasks.md +31 -0
- occfg-0.1.0/openspec/config.yaml +32 -0
- occfg-0.1.0/openspec/specs/cli-flags/spec.md +61 -0
- occfg-0.1.0/openspec/specs/error-handling/spec.md +95 -0
- occfg-0.1.0/openspec/specs/ollama-support/spec.md +101 -0
- occfg-0.1.0/openspec/specs/server-management/spec.md +114 -0
- occfg-0.1.0/pyproject.toml +27 -0
- occfg-0.1.0/src/opencode_config/__init__.py +0 -0
- occfg-0.1.0/src/opencode_config/__main__.py +3 -0
- occfg-0.1.0/src/opencode_config/adapters/__init__.py +0 -0
- occfg-0.1.0/src/opencode_config/adapters/lemonade_client.py +47 -0
- occfg-0.1.0/src/opencode_config/adapters/ollama_client.py +79 -0
- occfg-0.1.0/src/opencode_config/adapters/opencode_config.py +24 -0
- occfg-0.1.0/src/opencode_config/adapters/server_registry.py +103 -0
- occfg-0.1.0/src/opencode_config/cli/__init__.py +0 -0
- occfg-0.1.0/src/opencode_config/cli/main.py +179 -0
- occfg-0.1.0/src/opencode_config/domain/__init__.py +0 -0
- occfg-0.1.0/src/opencode_config/domain/entities.py +39 -0
- occfg-0.1.0/src/opencode_config/domain/ports.py +45 -0
- occfg-0.1.0/src/opencode_config/use_cases/__init__.py +0 -0
- occfg-0.1.0/src/opencode_config/use_cases/helpers.py +83 -0
- occfg-0.1.0/src/opencode_config/use_cases/list_servers.py +40 -0
- occfg-0.1.0/src/opencode_config/use_cases/server_management.py +78 -0
- occfg-0.1.0/src/opencode_config/use_cases/sync.py +69 -0
- occfg-0.1.0/tests/__init__.py +0 -0
- occfg-0.1.0/tests/conftest.py +215 -0
- occfg-0.1.0/tests/test_adapters/__init__.py +0 -0
- occfg-0.1.0/tests/test_adapters/test_lemonade_client.py +100 -0
- occfg-0.1.0/tests/test_adapters/test_ollama_client.py +117 -0
- occfg-0.1.0/tests/test_adapters/test_opencode_config.py +46 -0
- occfg-0.1.0/tests/test_adapters/test_server_registry.py +243 -0
- occfg-0.1.0/tests/test_cli/__init__.py +0 -0
- occfg-0.1.0/tests/test_cli/test_main.py +327 -0
- occfg-0.1.0/tests/test_domain/__init__.py +0 -0
- occfg-0.1.0/tests/test_domain/test_entities.py +84 -0
- occfg-0.1.0/tests/test_e2e/__init__.py +0 -0
- occfg-0.1.0/tests/test_e2e/test_empty_models.py +247 -0
- occfg-0.1.0/tests/test_repro_issue.py +10 -0
- occfg-0.1.0/tests/test_use_cases/__init__.py +0 -0
- occfg-0.1.0/tests/test_use_cases/test_helpers.py +167 -0
- occfg-0.1.0/tests/test_use_cases/test_list_servers.py +133 -0
- occfg-0.1.0/tests/test_use_cases/test_server_management.py +185 -0
- occfg-0.1.0/tests/test_use_cases/test_sync.py +368 -0
- occfg-0.1.0/uv.lock +502 -0
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: ["**"]
|
|
6
|
+
tags: ["v*"]
|
|
7
|
+
pull_request:
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
lint:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
- uses: astral-sh/setup-uv@v5
|
|
15
|
+
- run: uv sync --extra dev
|
|
16
|
+
- run: uv run ruff check .
|
|
17
|
+
|
|
18
|
+
test:
|
|
19
|
+
runs-on: ubuntu-latest
|
|
20
|
+
steps:
|
|
21
|
+
- uses: actions/checkout@v4
|
|
22
|
+
- uses: astral-sh/setup-uv@v5
|
|
23
|
+
- run: uv sync --extra dev
|
|
24
|
+
- run: uv run pytest
|
|
25
|
+
|
|
26
|
+
# Gitea-only: security scan (skipped on the GitHub mirror)
|
|
27
|
+
semgrep:
|
|
28
|
+
if: github.server_url == 'https://gitea.gatospingados.net'
|
|
29
|
+
runs-on: ubuntu-latest
|
|
30
|
+
steps:
|
|
31
|
+
- uses: actions/checkout@v4
|
|
32
|
+
- uses: astral-sh/setup-uv@v5
|
|
33
|
+
- run: uvx semgrep scan --config p/python --error
|
|
34
|
+
|
|
35
|
+
# Gitea-only: SonarQube analysis with quality-gate enforcement
|
|
36
|
+
sonar:
|
|
37
|
+
if: github.server_url == 'https://gitea.gatospingados.net'
|
|
38
|
+
runs-on: ubuntu-latest
|
|
39
|
+
steps:
|
|
40
|
+
- uses: actions/checkout@v4
|
|
41
|
+
with:
|
|
42
|
+
fetch-depth: 0
|
|
43
|
+
- uses: astral-sh/setup-uv@v5
|
|
44
|
+
- run: uv sync --extra dev
|
|
45
|
+
- run: uv run pytest # produces coverage.xml for SonarQube
|
|
46
|
+
- uses: sonarsource/sonarqube-scan-action@v4
|
|
47
|
+
env:
|
|
48
|
+
SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}
|
|
49
|
+
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
|
50
|
+
with:
|
|
51
|
+
args: >
|
|
52
|
+
-Dsonar.projectKey=opencode_config
|
|
53
|
+
-Dsonar.projectName=opencode_config
|
|
54
|
+
-Dsonar.sources=src
|
|
55
|
+
-Dsonar.python.coverage.reportPaths=coverage.xml
|
|
56
|
+
-Dsonar.qualitygate.wait=true
|
|
57
|
+
|
|
58
|
+
# GitHub-only: publish to PyPI on v* tags (OIDC, tokenless), after lint+test.
|
|
59
|
+
# Quality gates (semgrep/sonar) run on Gitea only and cannot be hard needs
|
|
60
|
+
# here — a skipped dependency would prevent publish from running at all.
|
|
61
|
+
publish:
|
|
62
|
+
if: >
|
|
63
|
+
startsWith(github.ref, 'refs/tags/v') &&
|
|
64
|
+
github.server_url == 'https://github.com'
|
|
65
|
+
needs: [lint, test]
|
|
66
|
+
runs-on: ubuntu-latest
|
|
67
|
+
permissions:
|
|
68
|
+
id-token: write
|
|
69
|
+
steps:
|
|
70
|
+
- uses: actions/checkout@v4
|
|
71
|
+
- uses: astral-sh/setup-uv@v5
|
|
72
|
+
- name: Guard tag matches pyproject version (semver)
|
|
73
|
+
run: |
|
|
74
|
+
TAG="${GITHUB_REF_NAME#v}"
|
|
75
|
+
VER="$(sed -n 's/^version = "\(.*\)"$/\1/p' pyproject.toml)"
|
|
76
|
+
if [ "$TAG" != "$VER" ]; then
|
|
77
|
+
echo "tag v$TAG does not match pyproject.toml version $VER" >&2
|
|
78
|
+
exit 1
|
|
79
|
+
fi
|
|
80
|
+
- run: uv build
|
|
81
|
+
- run: uv publish
|
occfg-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
### JetBrains template
|
|
2
|
+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
|
|
3
|
+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
|
4
|
+
|
|
5
|
+
# User-specific stuff
|
|
6
|
+
.idea
|
|
7
|
+
|
|
8
|
+
# Gradle and Maven with auto-import
|
|
9
|
+
# When using Gradle or Maven with auto-import, you should exclude module files,
|
|
10
|
+
# since they will be recreated, and may cause churn. Uncomment if using
|
|
11
|
+
# auto-import.
|
|
12
|
+
# .idea/artifacts
|
|
13
|
+
# .idea/compiler.xml
|
|
14
|
+
# .idea/jarRepositories.xml
|
|
15
|
+
# .idea/modules.xml
|
|
16
|
+
# .idea/*.iml
|
|
17
|
+
# .idea/modules
|
|
18
|
+
# *.iml
|
|
19
|
+
# *.ipr
|
|
20
|
+
|
|
21
|
+
# CMake
|
|
22
|
+
cmake-build-*/
|
|
23
|
+
|
|
24
|
+
# Mongo Explorer plugin
|
|
25
|
+
.idea/**/mongoSettings.xml
|
|
26
|
+
|
|
27
|
+
# File-based project format
|
|
28
|
+
*.iws
|
|
29
|
+
|
|
30
|
+
# IntelliJ
|
|
31
|
+
out/
|
|
32
|
+
|
|
33
|
+
# mpeltonen/sbt-idea plugin
|
|
34
|
+
.idea_modules/
|
|
35
|
+
|
|
36
|
+
# JIRA plugin
|
|
37
|
+
atlassian-ide-plugin.xml
|
|
38
|
+
|
|
39
|
+
# Cursive Clojure plugin
|
|
40
|
+
.idea/replstate.xml
|
|
41
|
+
|
|
42
|
+
# SonarLint plugin
|
|
43
|
+
.idea/sonarlint/
|
|
44
|
+
|
|
45
|
+
# Crashlytics plugin (for Android Studio and IntelliJ)
|
|
46
|
+
com_crashlytics_export_strings.xml
|
|
47
|
+
crashlytics.properties
|
|
48
|
+
crashlytics-build.properties
|
|
49
|
+
fabric.properties
|
|
50
|
+
|
|
51
|
+
# Editor-based Rest Client
|
|
52
|
+
.idea/httpRequests
|
|
53
|
+
|
|
54
|
+
# Android studio 3.1+ serialized cache file
|
|
55
|
+
.idea/caches/build_file_checksums.ser
|
|
56
|
+
|
|
57
|
+
### Python template
|
|
58
|
+
# Byte-compiled / optimized / DLL files
|
|
59
|
+
__pycache__/
|
|
60
|
+
*.py[cod]
|
|
61
|
+
*$py.class
|
|
62
|
+
|
|
63
|
+
# C extensions
|
|
64
|
+
*.so
|
|
65
|
+
|
|
66
|
+
# Distribution / packaging
|
|
67
|
+
.Python
|
|
68
|
+
build/
|
|
69
|
+
develop-eggs/
|
|
70
|
+
dist/
|
|
71
|
+
downloads/
|
|
72
|
+
eggs/
|
|
73
|
+
.eggs/
|
|
74
|
+
lib/
|
|
75
|
+
lib64/
|
|
76
|
+
parts/
|
|
77
|
+
sdist/
|
|
78
|
+
var/
|
|
79
|
+
wheels/
|
|
80
|
+
share/python-wheels/
|
|
81
|
+
*.egg-info/
|
|
82
|
+
.installed.cfg
|
|
83
|
+
*.egg
|
|
84
|
+
MANIFEST
|
|
85
|
+
|
|
86
|
+
# PyInstaller
|
|
87
|
+
# Usually these files are written by a python script from a template
|
|
88
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
89
|
+
*.manifest
|
|
90
|
+
*.spec
|
|
91
|
+
|
|
92
|
+
# Installer logs
|
|
93
|
+
pip-log.txt
|
|
94
|
+
pip-delete-this-directory.txt
|
|
95
|
+
|
|
96
|
+
# Unit test / coverage reports
|
|
97
|
+
htmlcov/
|
|
98
|
+
.tox/
|
|
99
|
+
.nox/
|
|
100
|
+
.coverage
|
|
101
|
+
.coverage.*
|
|
102
|
+
.cache
|
|
103
|
+
nosetests.xml
|
|
104
|
+
coverage.xml
|
|
105
|
+
*.cover
|
|
106
|
+
*.py,cover
|
|
107
|
+
.hypothesis/
|
|
108
|
+
.pytest_cache/
|
|
109
|
+
cover/
|
|
110
|
+
|
|
111
|
+
# Translations
|
|
112
|
+
*.mo
|
|
113
|
+
*.pot
|
|
114
|
+
|
|
115
|
+
# Django stuff:
|
|
116
|
+
*.log
|
|
117
|
+
local_settings.py
|
|
118
|
+
db.sqlite3
|
|
119
|
+
db.sqlite3-journal
|
|
120
|
+
|
|
121
|
+
# Flask stuff:
|
|
122
|
+
instance/
|
|
123
|
+
.webassets-cache
|
|
124
|
+
|
|
125
|
+
# Scrapy stuff:
|
|
126
|
+
.scrapy
|
|
127
|
+
|
|
128
|
+
# Sphinx documentation
|
|
129
|
+
docs/_build/
|
|
130
|
+
|
|
131
|
+
# PyBuilder
|
|
132
|
+
.pybuilder/
|
|
133
|
+
target/
|
|
134
|
+
|
|
135
|
+
# Jupyter Notebook
|
|
136
|
+
.ipynb_checkpoints
|
|
137
|
+
|
|
138
|
+
# IPython
|
|
139
|
+
profile_default/
|
|
140
|
+
ipython_config.py
|
|
141
|
+
|
|
142
|
+
# pyenv
|
|
143
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
144
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
145
|
+
# .python-version
|
|
146
|
+
|
|
147
|
+
# pipenv
|
|
148
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
149
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
150
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
151
|
+
# install all needed dependencies.
|
|
152
|
+
#Pipfile.lock
|
|
153
|
+
|
|
154
|
+
# poetry
|
|
155
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
156
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
157
|
+
# commonly ignored for libraries.
|
|
158
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
159
|
+
#poetry.lock
|
|
160
|
+
|
|
161
|
+
# pdm
|
|
162
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
163
|
+
#pdm.lock
|
|
164
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
165
|
+
# in version control.
|
|
166
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
167
|
+
.pdm.toml
|
|
168
|
+
.pdm-python
|
|
169
|
+
.pdm-build/
|
|
170
|
+
|
|
171
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
172
|
+
__pypackages__/
|
|
173
|
+
|
|
174
|
+
# Celery stuff
|
|
175
|
+
celerybeat-schedule
|
|
176
|
+
celerybeat.pid
|
|
177
|
+
|
|
178
|
+
# SageMath parsed files
|
|
179
|
+
*.sage.py
|
|
180
|
+
|
|
181
|
+
# Environments
|
|
182
|
+
.env
|
|
183
|
+
.venv
|
|
184
|
+
env/
|
|
185
|
+
venv/
|
|
186
|
+
ENV/
|
|
187
|
+
env.bak/
|
|
188
|
+
venv.bak/
|
|
189
|
+
|
|
190
|
+
# Spyder project settings
|
|
191
|
+
.spyderproject
|
|
192
|
+
.spyproject
|
|
193
|
+
|
|
194
|
+
# Rope project settings
|
|
195
|
+
.ropeproject
|
|
196
|
+
|
|
197
|
+
# mkdocs documentation
|
|
198
|
+
/site
|
|
199
|
+
|
|
200
|
+
# mypy
|
|
201
|
+
.mypy_cache/
|
|
202
|
+
.dmypy.json
|
|
203
|
+
dmypy.json
|
|
204
|
+
|
|
205
|
+
# Pyre type checker
|
|
206
|
+
.pyre/
|
|
207
|
+
|
|
208
|
+
# pytype static type analyzer
|
|
209
|
+
.pytype/
|
|
210
|
+
|
|
211
|
+
# Cython debug symbols
|
|
212
|
+
cython_debug/
|
|
213
|
+
|
|
214
|
+
# PyCharm
|
|
215
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
216
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
217
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
218
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
219
|
+
#.idea/
|
|
220
|
+
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
[]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.0
|
|
File without changes
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Implement tasks from an OpenSpec change (Experimental)"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Implement tasks from an OpenSpec change.
|
|
6
|
+
|
|
7
|
+
**Store selection:** If the user names a store (a store is a standalone OpenSpec repo registered on this machine) or the work lives in one, run `openspec store list --json` to discover registered store ids, then pass `--store <id>` on the commands that read or write specs and changes (`new change`, `status`, `instructions`, `list`, `show`, `validate`, `archive`, `doctor`, `context`, `schemas`, `view`). Once selected, treat `--store <id>` as sticky for the rest of the workflow. Every unscoped example of those commands below is shorthand: before running it, append the flag. For example, run `openspec status --change "<name>" --json --store "<id>"`, not the unscoped form shown below. Other commands do not take the flag. Hints printed by commands already carry the flag; keep it on follow-ups. Without a store, commands act on the nearest local `openspec/` root.
|
|
8
|
+
|
|
9
|
+
**Input**: Optionally specify a change name (e.g., `/opsx-apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
10
|
+
**Provided arguments**: $ARGUMENTS
|
|
11
|
+
|
|
12
|
+
**Steps**
|
|
13
|
+
|
|
14
|
+
1. **Select the change**
|
|
15
|
+
|
|
16
|
+
If a name is provided, use it. Otherwise:
|
|
17
|
+
- Infer from conversation context if the user mentioned a change
|
|
18
|
+
- Auto-select if only one active change exists
|
|
19
|
+
- If ambiguous, run `openspec list --json` to get available changes and ask the user to select one
|
|
20
|
+
|
|
21
|
+
Always announce: "Using change: <name>" and how to override (e.g., `/opsx-apply <other>`).
|
|
22
|
+
|
|
23
|
+
2. **Check status to understand the schema**
|
|
24
|
+
```bash
|
|
25
|
+
openspec status --change "<name>" --json
|
|
26
|
+
```
|
|
27
|
+
Parse the JSON to understand:
|
|
28
|
+
- `schemaName`: The workflow being used (e.g., "spec-driven")
|
|
29
|
+
- `planningHome`, `changeRoot`, and `actionContext`: planning scope and edit constraints
|
|
30
|
+
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
|
|
31
|
+
|
|
32
|
+
3. **Get apply instructions**
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
openspec instructions apply --change "<name>" --json
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This returns:
|
|
39
|
+
- `contextFiles`: artifact ID -> array of concrete file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
|
|
40
|
+
- Progress (total, complete, remaining)
|
|
41
|
+
- Task list with status
|
|
42
|
+
- Dynamic instruction based on current state
|
|
43
|
+
- Optional `context`: current required project instruction input from the selected root
|
|
44
|
+
- Optional `operationGuidance`: current advisory guidance for apply
|
|
45
|
+
|
|
46
|
+
**Handle states:**
|
|
47
|
+
- If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx-continue` (if it is not installed, run `openspec status --change "<name>" --json` to see the next artifact and `openspec instructions <artifact-id> --change "<name>" --json` for how to create it)
|
|
48
|
+
- If `state: "all_done"`: congratulate, suggest archive
|
|
49
|
+
- Otherwise: proceed to implementation
|
|
50
|
+
|
|
51
|
+
Treat `context` as a required prompt-level input. Read and consider it, and
|
|
52
|
+
apply relevant project facts, conventions, and constraints while implementing.
|
|
53
|
+
Treat `operationGuidance` as optional additive advice. Read and consider every
|
|
54
|
+
entry, and follow entries that are applicable and compatible with the built-in
|
|
55
|
+
workflow.
|
|
56
|
+
|
|
57
|
+
Keep both fields separate from CLI-returned state, missing artifacts, tasks,
|
|
58
|
+
progress, `contextFiles`, and the built-in `instruction`. They are not
|
|
59
|
+
evidence of task completion, do not replace the built-in instruction, and do
|
|
60
|
+
not permit bypassing a blocked state. If context conflicts with the built-in
|
|
61
|
+
instruction, an explicit user choice, or a CLI-controlled value, report the
|
|
62
|
+
conflict and preserve the controlling value. If guidance is inapplicable or
|
|
63
|
+
conflicts with those controlling inputs, do not follow it and explain why.
|
|
64
|
+
These are prompt-level behavior contracts, not enforceable checks.
|
|
65
|
+
|
|
66
|
+
4. **Read context files**
|
|
67
|
+
|
|
68
|
+
Read every file path listed under `contextFiles` from the apply instructions output.
|
|
69
|
+
The files depend on the schema being used:
|
|
70
|
+
- **spec-driven**: proposal, specs, design, tasks
|
|
71
|
+
- Other schemas: follow the contextFiles from CLI output
|
|
72
|
+
|
|
73
|
+
Do not copy `context` or `operationGuidance` verbatim into implementation
|
|
74
|
+
files or planning artifacts unless the user separately asks for that content.
|
|
75
|
+
|
|
76
|
+
5. **Show current progress**
|
|
77
|
+
|
|
78
|
+
Display:
|
|
79
|
+
- Schema being used
|
|
80
|
+
- Progress: "N/M tasks complete"
|
|
81
|
+
- Remaining tasks overview
|
|
82
|
+
- Dynamic instruction from CLI
|
|
83
|
+
|
|
84
|
+
6. **Implement tasks (loop until done or blocked)**
|
|
85
|
+
|
|
86
|
+
For each pending task:
|
|
87
|
+
- Show which task is being worked on
|
|
88
|
+
- Make the code changes required
|
|
89
|
+
- Keep changes minimal and focused
|
|
90
|
+
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
|
|
91
|
+
- Continue to next task
|
|
92
|
+
|
|
93
|
+
**Pause if:**
|
|
94
|
+
- Task is unclear → ask for clarification
|
|
95
|
+
- Implementation reveals a design issue → suggest updating artifacts
|
|
96
|
+
- A task needs work beyond what the spec and tasks describe, or you are tempted to drop, narrow, defer, or accept exceptions to specified behavior to make it fit → surface the added scope and ask; do not absorb it silently
|
|
97
|
+
- Error or blocker encountered → report and wait for guidance
|
|
98
|
+
- User interrupts
|
|
99
|
+
|
|
100
|
+
7. **On completion or pause, show status**
|
|
101
|
+
|
|
102
|
+
Display:
|
|
103
|
+
- Tasks completed this session
|
|
104
|
+
- Overall progress: "N/M tasks complete"
|
|
105
|
+
- If all done: suggest archive
|
|
106
|
+
- If paused: explain why and wait for guidance
|
|
107
|
+
|
|
108
|
+
**Output During Implementation**
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
## Implementing: <change-name> (schema: <schema-name>)
|
|
112
|
+
|
|
113
|
+
Working on task 3/7: <task description>
|
|
114
|
+
[...implementation happening...]
|
|
115
|
+
✓ Task complete
|
|
116
|
+
|
|
117
|
+
Working on task 4/7: <task description>
|
|
118
|
+
[...implementation happening...]
|
|
119
|
+
✓ Task complete
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
**Output On Completion**
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
## Implementation Complete
|
|
126
|
+
|
|
127
|
+
**Change:** <change-name>
|
|
128
|
+
**Schema:** <schema-name>
|
|
129
|
+
**Progress:** 7/7 tasks complete ✓
|
|
130
|
+
|
|
131
|
+
### Completed This Session
|
|
132
|
+
- [x] Task 1
|
|
133
|
+
- [x] Task 2
|
|
134
|
+
...
|
|
135
|
+
|
|
136
|
+
All tasks complete! You can archive this change with `/opsx-archive`.
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
**Output On Pause (Issue Encountered)**
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
## Implementation Paused
|
|
143
|
+
|
|
144
|
+
**Change:** <change-name>
|
|
145
|
+
**Schema:** <schema-name>
|
|
146
|
+
**Progress:** 4/7 tasks complete
|
|
147
|
+
|
|
148
|
+
### Issue Encountered
|
|
149
|
+
<description of the issue>
|
|
150
|
+
|
|
151
|
+
**Options:**
|
|
152
|
+
1. <option 1>
|
|
153
|
+
2. <option 2>
|
|
154
|
+
3. Other approach
|
|
155
|
+
|
|
156
|
+
What would you like to do?
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
**Guardrails**
|
|
160
|
+
- Keep going through tasks until done or blocked
|
|
161
|
+
- Always read context files before starting (from the apply instructions output)
|
|
162
|
+
- If task is ambiguous, pause and ask before implementing
|
|
163
|
+
- If implementation reveals issues, pause and suggest artifact updates
|
|
164
|
+
- Keep code changes minimal and scoped to each task
|
|
165
|
+
- Update task checkbox immediately after completing each task
|
|
166
|
+
- Pause on errors, blockers, or unclear requirements - don't guess
|
|
167
|
+
- When a task needs work beyond what the spec describes, surface the added scope and pause - never silently narrow, defer, or simplify away specified behavior
|
|
168
|
+
- Only mark a task `- [x]` when its specified behavior is fully implemented, not when it is partially done or deferred
|
|
169
|
+
- Use contextFiles from CLI output, don't assume specific file names
|
|
170
|
+
- Do not use context or operation guidance as proof that a task is complete
|
|
171
|
+
- Apply relevant project context; report conflicts with controlling workflow inputs
|
|
172
|
+
- Consider every guidance entry; explain any inapplicable or conflicting advice
|
|
173
|
+
- Do not copy runtime context or operation guidance into implementation files or planning artifacts
|
|
174
|
+
- Preserve CLI-controlled blocked/ready/all-done behavior and completion criteria
|
|
175
|
+
|
|
176
|
+
**Fluid Workflow Integration**
|
|
177
|
+
|
|
178
|
+
This skill supports the "actions on a change" model:
|
|
179
|
+
|
|
180
|
+
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
|
|
181
|
+
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
|