@paulojalowyj/openkit 0.2.0 → 0.2.1

package/README.md

@@ -27,9 +27,12 @@ npx @paulojalowyj/openkit init
 npx @paulojalowyj/openkit init --blueprint fullstack
 
 # Use the OpenCode Framework
-# (restart OpenCode TUI and use / commands)
+# (run opencode in your project and use / commands)
+opencode
 ```
 
+> **Important:** Use `npx` to run OpenKit commands. Do not install OpenKit as a project dependency (`npm install @paulojalowyj/openkit`). OpenKit is a CLI tool, not a runtime library.
+
 ## Upgrade
 
 ```bash

package/README.pt-BR.md

@@ -27,8 +27,11 @@ npx @paulojalowyj/openkit init --blueprint fullstack
 
 # Usar o OpenKit
 # (execute `opencode` no seu projeto e use os comandos /)
+opencode
 ```
 
+> **Importante:** Use `npx` para executar comandos do OpenKit. Não instale o OpenKit como dependência do projeto (`npm install @paulojalowyj/openkit`). OpenKit é uma ferramenta CLI, não uma biblioteca de runtime.
+
 ## Upgrade
 
 ```bash

package/bin/cli.js

@@ -375,7 +375,7 @@ async function copyBlueprint(blueprintName, targetDir, replacements) {
 program
   .name('openkit')
   .description('OpenKit - OpenCode Agent System in your project')
-  .version('0.2.0');
+  .version('0.2.1');
 
 program
   .command('init')
@@ -482,18 +482,37 @@ program
     }
 
     console.log('');
-    console.log(chalk.green(' Successfully initialized OpenCode!'));
-    console.log(chalk.cyan('\n Next steps:'));
-    console.log('  1. Restart OpenCode TUI');
-    console.log('  2. Use /engineer, /plan, /debug, and other commands');
+    console.log(chalk.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+    console.log(chalk.green(' ✓ OpenKit installed successfully!'));
+    console.log(chalk.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+    console.log('');
+    console.log(chalk.cyan(' Next steps:'));
+    console.log('');
+    console.log(chalk.white('  1. Start OpenCode in your project:'));
+    console.log(chalk.yellow('     opencode'));
+    console.log('');
+    console.log(chalk.white('  2. Use available commands:'));
+    console.log(chalk.gray('     /engineer   - Universal builder with planning'));
+    console.log(chalk.gray('     /plan       - Create implementation plan'));
+    console.log(chalk.gray('     /impl       - Implement features'));
+    console.log(chalk.gray('     /test       - Run tests'));
+    console.log(chalk.gray('     /debug      - Systematic debugging'));
 
     if (options.blueprint) {
       console.log('');
-      console.log(chalk.cyan('Development:'));
-      console.log('  1. Start services: docker compose -f docker-compose.dev.yml up -d');
-      console.log('  2. Access backend: http://localhost:8000');
-      console.log('  3. Access frontend: http://localhost:5173');
+      console.log(chalk.cyan(' Development environment:'));
+      console.log('');
+      console.log(chalk.white('  1. Start services:'));
+      console.log(chalk.yellow('     docker compose -f docker-compose.dev.yml up -d'));
+      console.log('');
+      console.log(chalk.white('  2. Access application:'));
+      console.log(chalk.gray('     Backend:  http://localhost:8000'));
+      console.log(chalk.gray('     Frontend: http://localhost:5173'));
+      console.log(chalk.gray('     API Docs: http://localhost:8000/docs'));
     }
+    
+    console.log('');
+    console.log(chalk.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
     console.log('');
   });
 

package/bin/postinstall-check.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+import { join } from 'path';
+import { existsSync, readFileSync } from 'fs';
+
+// ANSI color codes (sem dependências externas)
+const colors = {
+  reset: '\x1b[0m',
+  yellow: '\x1b[33m',
+  white: '\x1b[37m',
+  cyan: '\x1b[36m',
+  gray: '\x1b[90m'
+};
+
+// Detectar se está sendo instalado como dependência via npm env vars
+// INIT_CWD = diretório onde o usuário executou npm install
+const initCwd = process.env.INIT_CWD;
+
+// Se não temos INIT_CWD, provavelmente é desenvolvimento ou npx
+if (!initCwd) {
+  process.exit(0);
+}
+
+// Caminho do package.json do projeto pai (onde npm install foi executado)
+const parentPackageJson = join(initCwd, 'package.json');
+
+// Ler o package.json do projeto pai
+if (!existsSync(parentPackageJson)) {
+  process.exit(0);
+}
+
+try {
+  const pkg = JSON.parse(readFileSync(parentPackageJson, 'utf8'));
+  const hasOpenKit =
+    pkg.dependencies?.['@paulojalowyj/openkit'] ||
+    pkg.devDependencies?.['@paulojalowyj/openkit'];
+
+  if (hasOpenKit) {
+    console.error('');
+    console.error(`${colors.yellow}OpenKit detected as a project dependency${colors.reset}`);
+    console.error('');
+    console.error(`${colors.white}OpenKit does not need to be in your project's package.json.${colors.reset}`);
+    console.error(`${colors.white}The recommended way is to use npx directly:${colors.reset}`);
+    console.error('');
+    console.error(`${colors.cyan}  # Install OpenKit in your project${colors.reset}`);
+    console.error(`${colors.cyan}  npx @paulojalowyj/openkit init${colors.reset}`);
+    console.error('');
+    console.error(`${colors.cyan}  # Upgrade OpenKit${colors.reset}`);
+    console.error(`${colors.cyan}  npx @paulojalowyj/openkit upgrade${colors.reset}`);
+    console.error('');
+    console.error(`${colors.cyan}  # Start OpenCode in your project${colors.reset}`);
+    console.error(`${colors.cyan}  opencode${colors.reset}`);
+    console.error('');
+    console.error(`${colors.gray}To remove the dependency: npm uninstall @paulojalowyj/openkit${colors.reset}`);
+    console.error('');
+  }
+} catch (error) {
+  // Erro ao ler package.json, sair silenciosamente
+  process.exit(0);
+}

package/index.js

@@ -1,14 +1,28 @@
 /**
- * Opencode GLMs - Entry Point
+ * OpenKit - Entry Point
+ * 
+ * OpenKit should not be imported as a module.
+ * 
+ * Use the CLI via npx:
+ *   npx @paulojalowyj/openkit init
+ *   npx @paulojalowyj/openkit upgrade
+ * 
+ * Documentation: https://github.com/paulojalowyj/openkit
  */
 
-const path = require('path');
-const pkg = require('./package.json');
+console.error(`
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+OpenKit should not be imported as a module
 
-module.exports = {
-  name: pkg.name,
-  version: pkg.version,
-  description: pkg.description,
-  bin: path.resolve(__dirname, 'bin', 'cli.js'),
-  template: path.dirname(__dirname),
-};
+OpenKit is a CLI tool, not a code library.
+
+Use via npx:
+  npx @paulojalowyj/openkit init      # Install in project
+  npx @paulojalowyj/openkit upgrade   # Upgrade framework
+  opencode                            # Start OpenCode
+
+Documentation: https://github.com/paulojalowyj/openkit
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+`);
+
+process.exit(1);

package/package.json

@@ -1,13 +1,14 @@
 {
   "type": "module",
   "name": "@paulojalowyj/openkit",
-  "version": "0.2.0",
-  "description": "OpenKit - OpenCode Agent System - 15 specialized prompts, 33+ skills, validation scripts\n\nQuick Start:\n1. Install: npx @paulojalowyj/openkit init\n2. Start OpenCode: opencode\n3. Use workflows: /engineer, /plan, /impl, /test\n\nDocumentation: https://opencode.ai/docs",
+  "version": "0.2.1",
+  "description": "Use 'npx @paulojalowyj/openkit init' (not npm install). OpenKit is a CLI tool for OpenCode Agent System - 15 specialized agents, 33+ skills, validation scripts.\n\nQuick Start:\n1. Install: npx @paulojalowyj/openkit init\n2. Start OpenCode: opencode\n3. Use workflows: /engineer, /plan, /impl, /test\n\nDocumentation: https://opencode.ai/docs",
   "main": "index.js",
   "bin": {
     "openkit": "bin/cli.js"
   },
   "scripts": {
+    "postinstall": "node bin/postinstall-check.js",
     "init": "node bin/cli.js init",
     "doctor": "node bin/cli.js doctor",
     "test": "node --test test/*.test.js",
@@ -16,6 +17,7 @@
   },
   "files": [
     "bin",
+    "index.js",
     ".opencode",
     "opencode.json",
     "blueprints",
@@ -26,6 +28,9 @@
     "README.pt-BR.md"
   ],
   "keywords": [
+    "cli-tool",
+    "npx-only",
+    "no-install-needed",
     "ai",
     "agents",
     "opencode",