OktoSeek commited on
Commit
b0ad1a2
Β·
verified Β·
1 Parent(s): e2e5eea

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -31
README.md CHANGED
@@ -1,21 +1,3 @@
1
- ---
2
- tags:
3
- - ai
4
- - training
5
- - dsl
6
- - oktoscript
7
- - oktoseek
8
- - okto
9
- - automation
10
- - ai-pipelines
11
- - ai-governance
12
- language:
13
- - en
14
- frameworks:
15
- - pytorch
16
- - tensorflow
17
- ---
18
-
19
  <p align="center">
20
  <img src="./assets/okto_logo.png" alt="OktoScript Banner" width="50%" />
21
  </p>
@@ -63,7 +45,7 @@ frameworks:
63
  8. [Training Pipeline](#-training-pipeline)
64
  9. [OktoSeek Internal Formats](#-oktoseek-internal-formats)
65
  10. [Integration Targets](#️-integration-targets)
66
- 11. [VS Code Extension](#-vs-code-extension-coming-soon)
67
  12. [Documentation](#-documentation)
68
  13. [FAQ](#-frequently-asked-questions-faq)
69
  14. [License](#-license)
@@ -75,10 +57,11 @@ frameworks:
75
 
76
  **New to OktoScript?** Get started in 5 minutes:
77
 
78
- 1. **Read the guide:** [`docs/GETTING_STARTED.md`](./docs/GETTING_STARTED.md)
79
- 2. **Try an example:** [`examples/basic.okt`](./examples/basic.okt)
80
- 3. **Validate:** `okto validate examples/basic.okt`
81
- 4. **Train:** `okto train examples/basic.okt`
 
82
 
83
  πŸ“š **Full documentation:** [`docs/grammar.md`](./docs/grammar.md)
84
  πŸ” **Validation rules:** [`VALIDATION_RULES.md`](./VALIDATION_RULES.md)
@@ -117,7 +100,7 @@ OktoScript is the official language of the OktoSeek ecosystem and is used by:
117
  - 🎯 **OktoSeek IDE** – Visual AI development and experimentation
118
  - βš™οΈ **OktoEngine** – Core execution and decision engine
119
  - 🌐 **OktoScript Web Editor** – Online editor with syntax validation and autocomplete ([Try it now β†’](https://oktoseek.com/editor.php))
120
- - πŸ”Œ **VS Code Extension** – Code editing + validation (Coming Soon)
121
  - πŸ”„ **Autonomous pipelines** – Training, control, evaluation and inference
122
  - πŸ€– **AI agents** – Controlled, monitored intelligent systems
123
  - πŸ“± **Flutter / API deployments** – Cross-platform model integration
@@ -666,15 +649,46 @@ See [`/examples/`](./examples/) for examples using different export formats.
666
 
667
  ---
668
 
669
- ## πŸ“¦ VS Code Extension (Coming Soon)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
670
 
671
- - ✨ **Syntax Highlighting** - Beautiful code colors
672
- - πŸ” **OktoScript autocomplete** - Smart suggestions
673
- - ⚠️ **Error checking** - Real-time validation
674
- - ▢️ **Run / Train buttons** - One-click execution
675
- - 🎨 **Visual pipeline builder** - Drag-and-drop workflows
676
 
677
- > πŸ’‘ **Tip:** While waiting for the VS Code extension, use the [🌐 OktoScript Web Editor](https://oktoseek.com/editor.php) for syntax validation, autocomplete, and real-time error checking. It's fully integrated with the CLI via `okto web` command! The web editor provides the same features you'll find in the VS Code extension, including context-aware autocomplete and real-time syntax validation.
678
 
679
  ---
680
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  <p align="center">
2
  <img src="./assets/okto_logo.png" alt="OktoScript Banner" width="50%" />
3
  </p>
 
45
  8. [Training Pipeline](#-training-pipeline)
46
  9. [OktoSeek Internal Formats](#-oktoseek-internal-formats)
47
  10. [Integration Targets](#️-integration-targets)
48
+ 11. [VS Code Extension](#-vs-code-extension)
49
  12. [Documentation](#-documentation)
50
  13. [FAQ](#-frequently-asked-questions-faq)
51
  14. [License](#-license)
 
57
 
58
  **New to OktoScript?** Get started in 5 minutes:
59
 
60
+ 1. **Install VS Code Extension:** [Install OktoScript Extension](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript) (recommended for best experience)
61
+ 2. **Read the guide:** [`docs/GETTING_STARTED.md`](./docs/GETTING_STARTED.md)
62
+ 3. **Try an example:** [`examples/basic.okt`](./examples/basic.okt)
63
+ 4. **Validate:** `okto validate examples/basic.okt`
64
+ 5. **Train:** `okto train examples/basic.okt`
65
 
66
  πŸ“š **Full documentation:** [`docs/grammar.md`](./docs/grammar.md)
67
  πŸ” **Validation rules:** [`VALIDATION_RULES.md`](./VALIDATION_RULES.md)
 
100
  - 🎯 **OktoSeek IDE** – Visual AI development and experimentation
101
  - βš™οΈ **OktoEngine** – Core execution and decision engine
102
  - 🌐 **OktoScript Web Editor** – Online editor with syntax validation and autocomplete ([Try it now β†’](https://oktoseek.com/editor.php))
103
+ - πŸ”Œ **VS Code Extension** – Official VS Code extension with syntax highlighting, autocomplete, snippets, and validation ([Install now β†’](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript))
104
  - πŸ”„ **Autonomous pipelines** – Training, control, evaluation and inference
105
  - πŸ€– **AI agents** – Controlled, monitored intelligent systems
106
  - πŸ“± **Flutter / API deployments** – Cross-platform model integration
 
649
 
650
  ---
651
 
652
+ ## πŸ“¦ VS Code Extension
653
+
654
+ **Official OktoScript extension for Visual Studio Code is now available!**
655
+
656
+ [![Install OktoScript Extension](https://img.shields.io/badge/VS%20Code-Install%20OktoScript-blue?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript)
657
+
658
+ ### Features
659
+
660
+ - ✨ **Syntax Highlighting** - Beautiful color-coded OktoScript syntax for all blocks, keywords, and values
661
+ - πŸ” **Smart Autocomplete** - Context-aware suggestions based on the current block (ENV, DATASET, MODEL, TRAIN, etc.)
662
+ - πŸ“ **Code Snippets** - Quick templates for all OktoScript blocks (PROJECT, MODEL, TRAIN, CONTROL, INFERENCE, FT_LORA, etc.)
663
+ - βœ… **Syntax Validation** - Validate your `.okt` files using OktoEngine directly from VS Code
664
+ - 🌐 **Web Editor Integration** - Open files directly in the OktoScript Web Editor with one command
665
+ - 🎯 **Intelligent Suggestions** - Autocomplete triggers automatically on typing or pressing space
666
+ - πŸ“š **Block Templates** - Selecting a block from autocomplete generates a complete template (e.g., `MODEL { }`)
667
+
668
+ ### Installation
669
+
670
+ **From VS Code Marketplace:**
671
+ 1. Open VS Code
672
+ 2. Press `Ctrl+Shift+X` (or `Cmd+Shift+X` on Mac) to open Extensions
673
+ 3. Search for "OktoScript"
674
+ 4. Click "Install"
675
+
676
+ **Or use command line:**
677
+ ```bash
678
+ code --install-extension OktoSeekAI.oktoscript
679
+ ```
680
+
681
+ **Direct Link:** [Install OktoScript Extension](https://marketplace.visualstudio.com/items?itemName=OktoSeekAI.oktoscript)
682
+
683
+ ### Usage
684
 
685
+ - **Syntax Highlighting:** Open any `.okt` file and enjoy beautiful syntax highlighting
686
+ - **Autocomplete:** Start typing a block name (e.g., `MODEL`, `TRAIN`) and see contextual suggestions
687
+ - **Snippets:** Type block names and press `Tab` to insert complete templates
688
+ - **Validation:** Press `Ctrl+Shift+P` β†’ "OktoScript: Validate current file" (requires OktoEngine)
689
+ - **Web Editor:** Press `Ctrl+Shift+P` β†’ "OktoScript: Open in Web Editor" (requires OktoEngine)
690
 
691
+ > πŸ’‘ **Tip:** The VS Code extension works seamlessly with the [🌐 OktoScript Web Editor](https://oktoseek.com/editor.php). Both provide context-aware autocomplete, real-time syntax validation, and full integration with OktoEngine via the `okto web` command!
692
 
693
  ---
694