shallok 0.1.3 → 0.1.4

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.
package/README.md CHANGED
@@ -29,17 +29,19 @@
29
29
 
30
30
  ## Two Ways to Use Shallok
31
31
 
32
- ### 1. Developer CLI Quickstart (`npx shallok init`)
32
+ ### 1. Developer CLI Quickstart (`npx shallok setup`)
33
33
 
34
34
  Run in any React, Next.js, Expo, Astro, or Vue project:
35
35
  ```bash
36
- npx shallok init
36
+ npx shallok setup
37
37
  ```
38
38
  This command automatically:
39
- 1. Analyzes project architecture, detected framework, and router.
40
- 2. Scaffolds `localization.json`, `localization_base/`, `messages/`, and framework runtime files.
41
- 3. Installs `shallok` into `devDependencies` using your detected package manager (pnpm, npm, yarn, or bun).
42
- 4. Installs AI agent skills directly into `.agents/skills/` and `skills/` so AI coding agents immediately recognize them.
39
+ 1. Detects project framework and architecture.
40
+ 2. Installs `shallok` into `devDependencies` using your detected package manager (pnpm, npm, yarn, or bun).
41
+ 3. Installs the matching AI agent skill directly into `.agents/skills/` and `skills/` (e.g. Next.js, React, Expo, Astro, or general fallback).
42
+ 4. Displays the next-step prompt to give to your AI coding agent: *"Add localization and translations for a, b, c, d languages"*.
43
+
44
+ > **Note for AI Agents**: `shallok setup` is intended only for human developers. AI Agents should never run `shallok setup`; instead, agents run `shallok init`, `shallok extract`, `shallok translate`, etc.
43
45
 
44
46
  ### 2. Direct AI Agent Skill Usage
45
47
 
@@ -59,11 +61,15 @@ The AI agent will:
59
61
 
60
62
  ### Project Setup & Analysis
61
63
  ```bash
64
+ # Setup Shallok in project (install devDependency + copy AI agent skill) - For developers only
65
+ shallok setup
66
+ shallok setup --framework nextjs
67
+
62
68
  # Analyze repository architecture without modifying files
63
69
  shallok analyze
64
70
  shallok analyze --json
65
71
 
66
- # Initialize configuration and framework files
72
+ # Initialize configuration and framework files (used by AI agents or developers)
67
73
  shallok init
68
74
  shallok init --source en --locales kn,hi,fr --framework react --yes
69
75
  ```