sublation-os 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +157 -155
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,155 +1,157 @@
1
- # Sublation-OS Framework
2
-
3
- A comprehensive development framework for Claude Code that enhances your AI-assisted development workflow with standards, specifications, memory, and powerful agents.
4
-
5
- ## What is Sublation-OS?
6
-
7
- Sublation-OS is a framework that supercharges your Claude Code experience by providing:
8
-
9
- - **📚 Standards Library**: Coding conventions, API design patterns, testing practices, and more
10
- - **📋 Specification System**: Structured approach to feature planning with requirements, tasks, and verification
11
- - **🧠 Memory System**: Durable learnings that persist across Claude Code sessions
12
- - **🤖 Specialized Agents**: 7 powerful agents for implementing, verifying, and planning features
13
- - **⚡ Slash Commands**: Quick commands for common workflows
14
-
15
- ## Quick Start
16
-
17
- ### Installation
18
-
19
- Install Sublation-OS in your project with a single command:
20
-
21
- ```bash
22
- npx sublation-os
23
- ```
24
-
25
- That's it! The framework will be installed in your current directory.
26
-
27
- For alternative installation methods (script installation, git submodules), see the [Installation Guide](INSTALL.md).
28
-
29
- ### What Gets Installed
30
-
31
- The installer will create/update these directories in your project:
32
-
33
- ```
34
- your-project/
35
- ├── .sublation-os/ # Framework core
36
- │ ├── config.yml # Configuration
37
- ├── memory/ # Learned lessons
38
- │ ├── specs/ # Feature specifications
39
- └── standards/ # Coding standards
40
- ├── .claude/
41
- ├── agents/sublation-os/ # 7 specialized agents
42
- │ └── commands/sublation-os/ # Slash commands
43
- ```
44
-
45
- ## Features
46
-
47
- ### Standards Library
48
-
49
- 15 comprehensive standards files covering:
50
- - Backend development (API design, error handling, security)
51
- - Frontend development (UI/UX, state management, accessibility)
52
- - Data & Testing (database, testing practices)
53
- - DevOps & Documentation
54
-
55
- Customize these for your tech stack to give Claude Code consistent guidance.
56
-
57
- ### Specification Workflow
58
-
59
- Create structured specifications for new features:
60
-
61
- 1. **Initialize**: Use the spec-initializer agent to create a new spec
62
- 2. **Plan**: Define requirements, create task lists, gather visuals
63
- 3. **Implement**: Follow the task list with the implementer agent
64
- 4. **Verify**: Ensure end-to-end functionality with verification agent
65
-
66
- ### Memory System
67
-
68
- Capture durable learnings from each session:
69
- - Anti-patterns discovered
70
- - Performance optimizations
71
- - Architecture decisions
72
- - Gotchas and edge cases
73
-
74
- Claude Code automatically loads these lessons in future sessions.
75
-
76
- ### Slash Commands
77
-
78
- Quick access to common workflows:
79
-
80
- - `/sublation-os:learn` - Capture a learning
81
- - `/sublation-os:plan-product` - Create product documentation
82
- - `/sublation-os:create-tasks` - Generate task list from spec
83
- - `/sublation-os:implement-tasks` - Implement tasks from spec
84
- - `/sublation-os:commit-message` - Generate git commit message
85
- - `/sublation-os:review` - Code review
86
- - `/sublation-os:pr-description` - Generate PR description
87
-
88
- ## Documentation
89
-
90
- - [Installation Guide](INSTALL.md) - Detailed installation options
91
- - [Setup Guide](docs/setup-guide.md) - First-time setup and customization
92
- - [Updating Guide](docs/updating.md) - How to update the framework
93
- - [Agents & Commands](docs/agents-and-commands.md) - Using the specialized agents
94
- - [Customizing Standards](docs/customizing-standards.md) - Adapting to your tech stack
95
-
96
- ## Philosophy
97
-
98
- Sublation-OS is inspired by the philosophical concept of *Aufheben* (sublation) - the idea of preserving and transcending knowledge. Each development session builds on learnings from previous sessions, creating a continuously improving development experience.
99
-
100
- ## Requirements
101
-
102
- - [Claude Code](https://claude.ai/claude-code) - AI-powered CLI development tool
103
- - [Node.js](https://nodejs.org/) (version 14 or higher) - For npx installation
104
- - Git (optional, for submodule installation)
105
-
106
- ## Updating
107
-
108
- Sublation-OS separates framework files (commands, agents) from your project data (memory, standards, specs). Updates only replace framework files while preserving your data.
109
-
110
- **Using npx (Recommended):**
111
-
112
- Simply run the installer again to update to the latest version:
113
-
114
- ```bash
115
- npx sublation-os@latest
116
- ```
117
-
118
- The installer will detect your existing installation, create a backup, and update to the latest version.
119
-
120
- **Using the update scripts:**
121
-
122
- Linux/Mac:
123
- ```bash
124
- ./update-framework.sh
125
- ```
126
-
127
- Windows:
128
- ```powershell
129
- .\update-framework.ps1
130
- ```
131
-
132
- **Manual update:**
133
- ```bash
134
- # Clone the latest version
135
- git clone https://github.com/nicolosaullo/sublation-os.git /tmp/sublation-os-update
136
-
137
- # Update framework files only
138
- rm -rf .claude/commands/sublation-os .claude/agents/sublation-os
139
- cp -r /tmp/sublation-os-update/.claude/commands/sublation-os .claude/commands/
140
- cp -r /tmp/sublation-os-update/.claude/agents/sublation-os .claude/agents/
141
- ```
142
-
143
- Your `.sublation-os/` directory (memory, standards, specs) remains untouched.
144
-
145
- ## Contributing
146
-
147
- Contributions welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
148
-
149
- ## License
150
-
151
- MIT License - see [LICENSE](LICENSE) for details.
152
-
153
- ## Credits
154
-
155
- Created to enhance Claude Code development workflows. Built with love for developers who want their AI assistant to remember and improve.
1
+ <img width="1536" height="1024" alt="image" src="https://github.com/user-attachments/assets/543d74f3-17ea-4372-bff7-88666983ec05" />
2
+
3
+ # Sublation-OS Framework
4
+
5
+ A comprehensive development framework for Claude Code that enhances your AI-assisted development workflow with standards, specifications, memory, and powerful agents.
6
+
7
+ ## What is Sublation-OS?
8
+
9
+ Sublation-OS is a framework that supercharges your Claude Code experience by providing:
10
+
11
+ - **📚 Standards Library**: Coding conventions, API design patterns, testing practices, and more
12
+ - **📋 Specification System**: Structured approach to feature planning with requirements, tasks, and verification
13
+ - **🧠 Memory System**: Durable learnings that persist across Claude Code sessions
14
+ - **🤖 Specialized Agents**: 7 powerful agents for implementing, verifying, and planning features
15
+ - **⚡ Slash Commands**: Quick commands for common workflows
16
+
17
+ ## Quick Start
18
+
19
+ ### Installation
20
+
21
+ Install Sublation-OS in your project with a single command:
22
+
23
+ ```bash
24
+ npx sublation-os
25
+ ```
26
+
27
+ That's it! The framework will be installed in your current directory.
28
+
29
+ For alternative installation methods (script installation, git submodules), see the [Installation Guide](INSTALL.md).
30
+
31
+ ### What Gets Installed
32
+
33
+ The installer will create/update these directories in your project:
34
+
35
+ ```
36
+ your-project/
37
+ ├── .sublation-os/ # Framework core
38
+ │ ├── config.yml # Configuration
39
+ ├── memory/ # Learned lessons
40
+ ├── specs/ # Feature specifications
41
+ └── standards/ # Coding standards
42
+ ├── .claude/
43
+ │ ├── agents/sublation-os/ # 7 specialized agents
44
+ │ └── commands/sublation-os/ # Slash commands
45
+ ```
46
+
47
+ ## Features
48
+
49
+ ### Standards Library
50
+
51
+ 15 comprehensive standards files covering:
52
+ - Backend development (API design, error handling, security)
53
+ - Frontend development (UI/UX, state management, accessibility)
54
+ - Data & Testing (database, testing practices)
55
+ - DevOps & Documentation
56
+
57
+ Customize these for your tech stack to give Claude Code consistent guidance.
58
+
59
+ ### Specification Workflow
60
+
61
+ Create structured specifications for new features:
62
+
63
+ 1. **Initialize**: Use the spec-initializer agent to create a new spec
64
+ 2. **Plan**: Define requirements, create task lists, gather visuals
65
+ 3. **Implement**: Follow the task list with the implementer agent
66
+ 4. **Verify**: Ensure end-to-end functionality with verification agent
67
+
68
+ ### Memory System
69
+
70
+ Capture durable learnings from each session:
71
+ - Anti-patterns discovered
72
+ - Performance optimizations
73
+ - Architecture decisions
74
+ - Gotchas and edge cases
75
+
76
+ Claude Code automatically loads these lessons in future sessions.
77
+
78
+ ### Slash Commands
79
+
80
+ Quick access to common workflows:
81
+
82
+ - `/sublation-os:learn` - Capture a learning
83
+ - `/sublation-os:plan-product` - Create product documentation
84
+ - `/sublation-os:create-tasks` - Generate task list from spec
85
+ - `/sublation-os:implement-tasks` - Implement tasks from spec
86
+ - `/sublation-os:commit-message` - Generate git commit message
87
+ - `/sublation-os:review` - Code review
88
+ - `/sublation-os:pr-description` - Generate PR description
89
+
90
+ ## Documentation
91
+
92
+ - [Installation Guide](INSTALL.md) - Detailed installation options
93
+ - [Setup Guide](docs/setup-guide.md) - First-time setup and customization
94
+ - [Updating Guide](docs/updating.md) - How to update the framework
95
+ - [Agents & Commands](docs/agents-and-commands.md) - Using the specialized agents
96
+ - [Customizing Standards](docs/customizing-standards.md) - Adapting to your tech stack
97
+
98
+ ## Philosophy
99
+
100
+ Sublation-OS is inspired by the philosophical concept of *Aufheben* (sublation) - the idea of preserving and transcending knowledge. Each development session builds on learnings from previous sessions, creating a continuously improving development experience.
101
+
102
+ ## Requirements
103
+
104
+ - [Claude Code](https://claude.ai/claude-code) - AI-powered CLI development tool
105
+ - [Node.js](https://nodejs.org/) (version 14 or higher) - For npx installation
106
+ - Git (optional, for submodule installation)
107
+
108
+ ## Updating
109
+
110
+ Sublation-OS separates framework files (commands, agents) from your project data (memory, standards, specs). Updates only replace framework files while preserving your data.
111
+
112
+ **Using npx (Recommended):**
113
+
114
+ Simply run the installer again to update to the latest version:
115
+
116
+ ```bash
117
+ npx sublation-os@latest
118
+ ```
119
+
120
+ The installer will detect your existing installation, create a backup, and update to the latest version.
121
+
122
+ **Using the update scripts:**
123
+
124
+ Linux/Mac:
125
+ ```bash
126
+ ./update-framework.sh
127
+ ```
128
+
129
+ Windows:
130
+ ```powershell
131
+ .\update-framework.ps1
132
+ ```
133
+
134
+ **Manual update:**
135
+ ```bash
136
+ # Clone the latest version
137
+ git clone https://github.com/nicolosaullo/sublation-os.git /tmp/sublation-os-update
138
+
139
+ # Update framework files only
140
+ rm -rf .claude/commands/sublation-os .claude/agents/sublation-os
141
+ cp -r /tmp/sublation-os-update/.claude/commands/sublation-os .claude/commands/
142
+ cp -r /tmp/sublation-os-update/.claude/agents/sublation-os .claude/agents/
143
+ ```
144
+
145
+ Your `.sublation-os/` directory (memory, standards, specs) remains untouched.
146
+
147
+ ## Contributing
148
+
149
+ Contributions welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
150
+
151
+ ## License
152
+
153
+ MIT License - see [LICENSE](LICENSE) for details.
154
+
155
+ ## Credits
156
+
157
+ Created to enhance Claude Code development workflows. Built with love for developers who want their AI assistant to remember and improve.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "sublation-os",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A comprehensive development framework for Claude Code that enhances your AI-assisted development workflow with standards, specifications, memory, and powerful agents",
5
5
  "main": "bin/install.js",
6
6
  "bin": {
7
- "sublation-os": "./bin/install.js"
7
+ "sublation-os": "bin/install.js"
8
8
  },
9
9
  "scripts": {
10
10
  "test": "echo \"Error: no test specified\" && exit 1"