summaryrefslogtreecommitdiffhomepage
path: root/cmd/schema/README.md
diff options
context:
space:
mode:
authoradamdottv <[email protected]>2025-05-29 15:22:25 -0500
committeradamdottv <[email protected]>2025-05-29 15:22:25 -0500
commit1c01ee48340c524af9223fac43f21d3a545e4583 (patch)
treef33bde056ef0d65828f15a9199ad0b910f65d74f /cmd/schema/README.md
parent005d6e0bde9a42e2bebee7b712b0fe9a7be23499 (diff)
downloadopencode-1c01ee48340c524af9223fac43f21d3a545e4583.tar.gz
opencode-1c01ee48340c524af9223fac43f21d3a545e4583.zip
wip: refactoring tui
Diffstat (limited to 'cmd/schema/README.md')
-rw-r--r--cmd/schema/README.md65
1 files changed, 0 insertions, 65 deletions
diff --git a/cmd/schema/README.md b/cmd/schema/README.md
deleted file mode 100644
index e448ea0cb..000000000
--- a/cmd/schema/README.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# OpenCode Configuration Schema Generator
-
-This tool generates a JSON Schema for the OpenCode configuration file. The schema can be used to validate configuration files and provide autocompletion in editors that support JSON Schema.
-
-## Usage
-
-```bash
-go run cmd/schema/main.go > opencode-schema.json
-```
-
-This will generate a JSON Schema file that can be used to validate configuration files.
-
-## Schema Features
-
-The generated schema includes:
-
-- All configuration options with descriptions
-- Default values where applicable
-- Validation for enum values (e.g., model IDs, provider types)
-- Required fields
-- Type checking
-
-## Using the Schema
-
-You can use the generated schema in several ways:
-
-1. **Editor Integration**: Many editors (VS Code, JetBrains IDEs, etc.) support JSON Schema for validation and autocompletion. You can configure your editor to use the generated schema for `.opencode.json` files.
-
-2. **Validation Tools**: You can use tools like [jsonschema](https://github.com/Julian/jsonschema) to validate your configuration files against the schema.
-
-3. **Documentation**: The schema serves as documentation for the configuration options.
-
-## Example Configuration
-
-Here's an example configuration that conforms to the schema:
-
-```json
-{
- "data": {
- "directory": ".opencode"
- },
- "debug": false,
- "providers": {
- "anthropic": {
- "apiKey": "your-api-key"
- }
- },
- "agents": {
- "primary": {
- "model": "claude-3.7-sonnet",
- "maxTokens": 5000,
- "reasoningEffort": "medium"
- },
- "task": {
- "model": "claude-3.7-sonnet",
- "maxTokens": 5000
- },
- "title": {
- "model": "claude-3.7-sonnet",
- "maxTokens": 80
- }
- }
-}
-```
-