cami-cli 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.
- package/README.md +128 -0
- package/index.js +1 -1
- package/package.json +2 -1
package/README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# CAMI CLI
|
|
2
|
+
|
|
3
|
+
A command-line interface tool for scaffolding CAMI (Cellular Automaton Model Interface) projects. Create plugin systems or visualization projects with a single command.
|
|
4
|
+
|
|
5
|
+
## 📦 Installation
|
|
6
|
+
|
|
7
|
+
Install globally via npm:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g cami-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 🚀 Usage
|
|
14
|
+
|
|
15
|
+
Run the CLI to create a new project:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
cami
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Or using npx (without global installation):
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx cami-cli
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The CLI will guide you through an interactive setup process where you can:
|
|
28
|
+
1. Name your project
|
|
29
|
+
2. Choose between Plugin or Visual project types
|
|
30
|
+
3. Customize your setup options
|
|
31
|
+
|
|
32
|
+
## 📋 Project Types
|
|
33
|
+
|
|
34
|
+
### Plugin Project
|
|
35
|
+
Creates a new system to extend functionality with custom plugins.
|
|
36
|
+
|
|
37
|
+
**Features:**
|
|
38
|
+
- Pre-configured C++ plugin skeleton
|
|
39
|
+
- CMake build system setup
|
|
40
|
+
- Template file system with automatic name replacement
|
|
41
|
+
- Git repository initialization
|
|
42
|
+
|
|
43
|
+
### Visual Project
|
|
44
|
+
Creates a new system to visualize plugins using modern web technologies.
|
|
45
|
+
|
|
46
|
+
**Features:**
|
|
47
|
+
- React + Vite setup
|
|
48
|
+
- Optional PixiJS integration for grid-based rendering
|
|
49
|
+
- Tailwind CSS for styling
|
|
50
|
+
- Custom hooks for grid management (optional)
|
|
51
|
+
- Git repository initialization
|
|
52
|
+
|
|
53
|
+
## 🛠️ Development
|
|
54
|
+
|
|
55
|
+
### Prerequisites
|
|
56
|
+
- Node.js (v14 or higher)
|
|
57
|
+
- npm or yarn
|
|
58
|
+
- Git
|
|
59
|
+
|
|
60
|
+
### Local Development
|
|
61
|
+
|
|
62
|
+
1. Clone the repository:
|
|
63
|
+
```bash
|
|
64
|
+
git clone https://github.com/Cellular-Automaton/CAMI-CLI.git
|
|
65
|
+
cd CAMI-CLI
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
2. Install dependencies:
|
|
69
|
+
```bash
|
|
70
|
+
npm install
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
3. Run locally:
|
|
74
|
+
```bash
|
|
75
|
+
npm start
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 📖 Project Structure
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
CAMI-CLI/
|
|
82
|
+
├── index.js # Main CLI entry point
|
|
83
|
+
├── package.json # Project metadata and dependencies
|
|
84
|
+
└── README.md # Documentation
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## 🤝 Contributing
|
|
88
|
+
|
|
89
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
90
|
+
|
|
91
|
+
## 📄 License
|
|
92
|
+
|
|
93
|
+
ISC
|
|
94
|
+
|
|
95
|
+
## 🔗 Links
|
|
96
|
+
|
|
97
|
+
- [GitHub Repository](https://github.com/Cellular-Automaton/CAMI-CLI)
|
|
98
|
+
- [Visual Skeleton](https://github.com/Cellular-Automaton/VisualSkeleton)
|
|
99
|
+
- [Plugin Skeleton](https://github.com/Cellular-Automaton/PluginSkeleton)
|
|
100
|
+
|
|
101
|
+
## 💡 Examples
|
|
102
|
+
|
|
103
|
+
### Creating a Plugin Project
|
|
104
|
+
```bash
|
|
105
|
+
$ cami
|
|
106
|
+
Welcome to the CAMI cli!
|
|
107
|
+
|
|
108
|
+
How do you want to name your project? my-awesome-plugin
|
|
109
|
+
Select the type of project: Plugin (A new system to extend functionality)
|
|
110
|
+
|
|
111
|
+
✓ Plugin project created successfully!
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Creating a Visual Project
|
|
115
|
+
```bash
|
|
116
|
+
$ cami
|
|
117
|
+
Welcome to the CAMI cli!
|
|
118
|
+
|
|
119
|
+
How do you want to name your project? my-visualization
|
|
120
|
+
Select the type of project: Visual (A new system to visualize plugins)
|
|
121
|
+
Do you want a base project with a grid and PixiJS setup? Yes
|
|
122
|
+
|
|
123
|
+
✓ Project created successfully!
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## 🐛 Issues
|
|
127
|
+
|
|
128
|
+
Found a bug? Please [open an issue](https://github.com/Cellular-Automaton/CAMI-CLI/issues) on GitHub.
|
package/index.js
CHANGED
package/package.json
CHANGED