catylst 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 +79 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,79 @@
1
+ # catylst
2
+
3
+ Generate customized **Kotlin Multiplatform** projects with an interactive wizard.
4
+
5
+ Instead of cloning a template and manually deleting files, just run `catylst` and answer a few questions. You get a ready-to-build KMP project with only the features you want.
6
+
7
+ ## Requirements
8
+
9
+ - **JDK 17+** — [Download from Adoptium](https://adoptium.net)
10
+ - **Git**
11
+
12
+ ## Install
13
+
14
+ ```bash
15
+ npm install -g catylst
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ ```bash
21
+ catylst --interactive
22
+ ```
23
+
24
+ The wizard walks you through:
25
+
26
+ - **Package name** — e.g. `com.example.myapp`
27
+ - **App name** — e.g. `MyApp`
28
+ - **Features** — pick from AI, Notifications, Permissions, Room, Preferences, Ktor, Server
29
+ - **AI provider** — Claude / Groq / Gemini (multi-select)
30
+ - **Sample code** — include demo screens or start clean
31
+ - **Theme** — pick any hex color, get a full Material 3 light + dark theme
32
+ - **Agent Skills** — install bloom-build, bloom-navigate, and community skills
33
+
34
+ ### Non-interactive
35
+
36
+ ```bash
37
+ catylst --package com.example.myapp --name MyApp --features ai,room,ktor
38
+ ```
39
+
40
+ ### All options
41
+
42
+ | Option | Description |
43
+ |--------|-------------|
44
+ | `--interactive`, `-i` | Run interactive wizard |
45
+ | `--package`, `-p` | Application package name |
46
+ | `--name`, `-n` | Application display name |
47
+ | `--features`, `-f` | Comma-separated: `ai,notifications,permissions,room,preferences,ktor,server` |
48
+ | `--no-sample` | Exclude sample/demo code |
49
+ | `--ai-provider`, `-a` | `claude`, `groq`, `gemini`, `none` |
50
+ | `--theme-color` | Seed color hex e.g. `#6750A4` |
51
+ | `--theme-expressive` | Enable Material 3 Expressive motion |
52
+ | `--output`, `-o` | Output directory (default: current dir) |
53
+
54
+ ## What gets generated
55
+
56
+ ```
57
+ MyApp/
58
+ ├── androidApp/ # Android entry point
59
+ ├── composeApp/ # Shared KMP code
60
+ │ ├── src/commonMain/
61
+ │ ├── src/androidMain/
62
+ │ ├── src/iosMain/
63
+ │ └── src/desktopMain/
64
+ ├── iosApp/ # iOS Xcode project
65
+ └── .claude/skills/ # AI agent skills (if selected)
66
+ ```
67
+
68
+ ## Updating
69
+
70
+ Re-run install to get the latest template and CLI:
71
+
72
+ ```bash
73
+ npm install -g catylst
74
+ ```
75
+
76
+ ## Links
77
+
78
+ - [GitHub](https://github.com/rohit-554/Catylst)
79
+ - [Report an issue](https://github.com/rohit-554/Catylst/issues)
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "catylst",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Generate customized Kotlin Multiplatform projects with an interactive wizard",
5
5
  "keywords": ["kotlin", "kmp", "android", "ios", "multiplatform", "compose", "generator"],
6
6
  "homepage": "https://github.com/rohit-554/Catylst",
7
7
  "repository": {
8
8
  "type": "git",
9
- "url": "https://github.com/rohit-554/Catylst.git"
9
+ "url": "git+https://github.com/rohit-554/Catylst.git"
10
10
  },
11
11
  "license": "MIT",
12
12
  "bin": {