@seeka-labs/cli-apps 3.9.2 → 3.9.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/dist/index.cjs +1 -1
- package/dist/init-template.zip +0 -0
- package/package.json +2 -3
- package/README.md +0 -286
package/dist/index.cjs
CHANGED
|
@@ -39932,7 +39932,7 @@ var os2 = __toESM(require("os"), 1);
|
|
|
39932
39932
|
var path7 = __toESM(require("path"), 1);
|
|
39933
39933
|
|
|
39934
39934
|
// package.json
|
|
39935
|
-
var version = "3.9.
|
|
39935
|
+
var version = "3.9.4";
|
|
39936
39936
|
|
|
39937
39937
|
// src/helpers/index.ts
|
|
39938
39938
|
var fs2 = __toESM(require("fs"), 1);
|
package/dist/init-template.zip
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seeka-labs/cli-apps",
|
|
3
|
-
"version": "3.9.
|
|
3
|
+
"version": "3.9.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Seeka - Apps CLI",
|
|
6
6
|
"author": "SEEKA <platform@seeka.co>",
|
|
@@ -68,6 +68,5 @@
|
|
|
68
68
|
"ts-jest": "^29",
|
|
69
69
|
"ts-node": "^10",
|
|
70
70
|
"typescript": "^5"
|
|
71
|
-
}
|
|
72
|
-
"gitHead": "6cc6b19261cbd4af64587a225406946210392c0c"
|
|
71
|
+
}
|
|
73
72
|
}
|
package/README.md
DELETED
|
@@ -1,286 +0,0 @@
|
|
|
1
|
-
# @seeka-labs/cli-apps
|
|
2
|
-
|
|
3
|
-
The official Seeka Apps CLI for scaffolding and managing Seeka applications.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
# Using npm
|
|
9
|
-
npm install -g @seeka-labs/cli-apps
|
|
10
|
-
|
|
11
|
-
# Using yarn
|
|
12
|
-
yarn global add @seeka-labs/cli-apps
|
|
13
|
-
|
|
14
|
-
# Or run directly with npx
|
|
15
|
-
npx @seeka-labs/cli-apps@latest
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Quick Start
|
|
19
|
-
|
|
20
|
-
The fastest way to get started is to run the CLI without any arguments to enter **interactive mode**:
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
npx @seeka-labs/cli-apps@latest
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
This will guide you through the setup process with prompts for all required information.
|
|
27
|
-
|
|
28
|
-
## Commands
|
|
29
|
-
|
|
30
|
-
### `init` - Initialize a New Seeka App
|
|
31
|
-
|
|
32
|
-
Creates a new Seeka app with the specified template and configuration.
|
|
33
|
-
|
|
34
|
-
#### Usage
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
# Interactive mode (recommended for first-time users)
|
|
38
|
-
npx @seeka-labs/cli-apps@latest
|
|
39
|
-
|
|
40
|
-
# Using command-line arguments
|
|
41
|
-
npx @seeka-labs/cli-apps@latest init <org> <name> [options]
|
|
42
|
-
|
|
43
|
-
# Using a configuration file
|
|
44
|
-
npx @seeka-labs/cli-apps@latest init <config-file.json>
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
#### Arguments
|
|
48
|
-
|
|
49
|
-
| Argument | Description |
|
|
50
|
-
|----------|-------------|
|
|
51
|
-
| `<configFileOrOrg>` | Path to JSON config file, or name of your organization (alphanumeric and hyphens only) |
|
|
52
|
-
| `[name]` | Name of your app (alphanumeric and hyphens only) |
|
|
53
|
-
|
|
54
|
-
#### Options
|
|
55
|
-
|
|
56
|
-
| Option | Description |
|
|
57
|
-
|--------|-------------|
|
|
58
|
-
| `--template <template>` | App template: `azure-function`, `aws-lambda`, or `netlify-function` |
|
|
59
|
-
| `--developer <developer>` | App developer name or company |
|
|
60
|
-
| `--email <email>` | App developer email |
|
|
61
|
-
| `--outName [outName]` | Directory name of the app (a new directory will be created with this name) |
|
|
62
|
-
| `--outDir [outDir]` | Output directory to create the app in (defaults to current working directory) |
|
|
63
|
-
| `--npmUsername [username]` | Private NPM registry username for browser plugin dependencies |
|
|
64
|
-
| `--npmPassword [password]` | Private NPM registry password for browser plugin dependencies |
|
|
65
|
-
| `--noDependencies` | Skip installing dependencies |
|
|
66
|
-
| `--skipSubDir` | Use sub directory for app files instead of root folder |
|
|
67
|
-
| `--force` | Force creation of app in non-empty directory |
|
|
68
|
-
| `--env [env...]` | Set environment variables (format: `--env KEY1=VALUE1 KEY2=VALUE2`) |
|
|
69
|
-
|
|
70
|
-
#### Examples
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
# Create a new Azure Function app
|
|
74
|
-
npx @seeka-labs/cli-apps@latest init my-org my-app \
|
|
75
|
-
--template azure-function \
|
|
76
|
-
--developer "My Company" \
|
|
77
|
-
--email "dev@mycompany.com"
|
|
78
|
-
|
|
79
|
-
# Create app with environment variables
|
|
80
|
-
npx @seeka-labs/cli-apps@latest init my-org my-app \
|
|
81
|
-
--template azure-function \
|
|
82
|
-
--developer "My Company" \
|
|
83
|
-
--email "dev@mycompany.com" \
|
|
84
|
-
--env "SEEKA_APP_ID=your-app-id" "SEEKA_APP_SECRET=your-secret"
|
|
85
|
-
|
|
86
|
-
# Create app without installing dependencies
|
|
87
|
-
npx @seeka-labs/cli-apps@latest init my-org my-app \
|
|
88
|
-
--template azure-function \
|
|
89
|
-
--developer "My Company" \
|
|
90
|
-
--email "dev@mycompany.com" \
|
|
91
|
-
--noDependencies
|
|
92
|
-
|
|
93
|
-
# Create app from a configuration file
|
|
94
|
-
npx @seeka-labs/cli-apps@latest init ./my-app-config.json
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
---
|
|
98
|
-
|
|
99
|
-
### `ai context` - Install AI Context Files
|
|
100
|
-
|
|
101
|
-
Installs AI context files to help AI assistants understand your Seeka app structure and provide better assistance.
|
|
102
|
-
|
|
103
|
-
#### Usage
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
# Install AI context to current directory
|
|
107
|
-
npx @seeka-labs/cli-apps@latest ai context
|
|
108
|
-
|
|
109
|
-
# Install AI context to a specific directory
|
|
110
|
-
npx @seeka-labs/cli-apps@latest ai context --target /path/to/project
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
#### Options
|
|
114
|
-
|
|
115
|
-
| Option | Description |
|
|
116
|
-
|--------|-------------|
|
|
117
|
-
| `--target <directory>` | Target directory (defaults to current directory) |
|
|
118
|
-
|
|
119
|
-
#### What It Does
|
|
120
|
-
|
|
121
|
-
- Downloads the Seeka AI context package
|
|
122
|
-
- Extracts it to `.seeka/ai/context/` in your project
|
|
123
|
-
- Provides documentation, architecture guides, and reference materials for AI assistants
|
|
124
|
-
- Replaces any existing AI context if present
|
|
125
|
-
|
|
126
|
-
#### Output Structure
|
|
127
|
-
|
|
128
|
-
```
|
|
129
|
-
.seeka/
|
|
130
|
-
└── ai/
|
|
131
|
-
└── context/
|
|
132
|
-
├── README.md
|
|
133
|
-
├── architecture/
|
|
134
|
-
│ └── overview.md
|
|
135
|
-
├── guides/
|
|
136
|
-
│ ├── getting-started.md
|
|
137
|
-
│ ├── common-patterns.md
|
|
138
|
-
│ ├── data-flow.md
|
|
139
|
-
│ └── testing.md
|
|
140
|
-
├── reference/
|
|
141
|
-
│ ├── cli-commands.md
|
|
142
|
-
│ ├── config-schema.md
|
|
143
|
-
│ └── sdk-api.md
|
|
144
|
-
└── meta.json
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
## Interactive Mode
|
|
150
|
-
|
|
151
|
-
When you run the CLI without any arguments, it enters interactive mode:
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
npx @seeka-labs/cli-apps@latest
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
### Available Actions
|
|
158
|
-
|
|
159
|
-
1. **Initialize a new Seeka app** - Guides you through creating a new app with prompts for:
|
|
160
|
-
- Organization name
|
|
161
|
-
- App name
|
|
162
|
-
- Template selection (azure-function, aws-lambda, netlify-function)
|
|
163
|
-
- Seeka App ID and Secret
|
|
164
|
-
- Developer name and email
|
|
165
|
-
- Output directory options
|
|
166
|
-
- Dependency installation preferences
|
|
167
|
-
- NPM registry credentials (for browser plugin)
|
|
168
|
-
- Additional options (force, skipSubDir)
|
|
169
|
-
|
|
170
|
-
2. **Install AI context files** - Downloads and installs AI context to help AI assistants understand your project
|
|
171
|
-
|
|
172
|
-
---
|
|
173
|
-
|
|
174
|
-
## Configuration File
|
|
175
|
-
|
|
176
|
-
You can use a JSON configuration file instead of command-line arguments:
|
|
177
|
-
|
|
178
|
-
```json
|
|
179
|
-
{
|
|
180
|
-
"orgName": "my-org",
|
|
181
|
-
"appName": "my-app",
|
|
182
|
-
"template": "azure-function",
|
|
183
|
-
"developerName": "My Company",
|
|
184
|
-
"developerEmail": "dev@mycompany.com",
|
|
185
|
-
"outputDirectory": "./",
|
|
186
|
-
"installDependencies": true,
|
|
187
|
-
"force": false,
|
|
188
|
-
"skipSubDir": false,
|
|
189
|
-
"environmentVariables": {
|
|
190
|
-
"SEEKA_APP_ID": "your-app-id",
|
|
191
|
-
"SEEKA_APP_SECRET": "your-secret"
|
|
192
|
-
},
|
|
193
|
-
"npmUsername": "your-npm-username",
|
|
194
|
-
"npmPassword": "your-npm-password"
|
|
195
|
-
}
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Then run:
|
|
199
|
-
|
|
200
|
-
```bash
|
|
201
|
-
npx @seeka-labs/cli-apps@latest init ./my-config.json
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
---
|
|
205
|
-
|
|
206
|
-
## Templates
|
|
207
|
-
|
|
208
|
-
### Azure Function (`azure-function`)
|
|
209
|
-
|
|
210
|
-
Creates a Seeka app designed to run on Azure Functions. Includes:
|
|
211
|
-
- Azure Functions project structure
|
|
212
|
-
- Server-side webhook handlers
|
|
213
|
-
- Local development setup with Azurite
|
|
214
|
-
- GitHub Actions deployment workflow
|
|
215
|
-
- GitLab CI/CD pipeline
|
|
216
|
-
|
|
217
|
-
### AWS Lambda (`aws-lambda`)
|
|
218
|
-
|
|
219
|
-
Creates a Seeka app designed to run on AWS Lambda. *(Coming soon)*
|
|
220
|
-
|
|
221
|
-
### Netlify Function (`netlify-function`)
|
|
222
|
-
|
|
223
|
-
Creates a Seeka app designed to run on Netlify Functions. *(Coming soon)*
|
|
224
|
-
|
|
225
|
-
---
|
|
226
|
-
|
|
227
|
-
## Project Structure
|
|
228
|
-
|
|
229
|
-
After running `init`, your project will have the following structure:
|
|
230
|
-
|
|
231
|
-
```
|
|
232
|
-
seeka-app-{name}/
|
|
233
|
-
├── .seeka/
|
|
234
|
-
│ ├── init.app.seeka.cli.config.json # CLI configuration
|
|
235
|
-
│ ├── init.app.secrets.seeka.cli.config.json # Environment variables
|
|
236
|
-
│ └── ai/
|
|
237
|
-
│ └── context/ # AI context files
|
|
238
|
-
├── app/
|
|
239
|
-
│ ├── lib/ # Shared library code
|
|
240
|
-
│ ├── server/ # Server-side code (Azure Functions)
|
|
241
|
-
│ ├── browser/ # Browser plugin code (optional)
|
|
242
|
-
│ └── ui/ # UI components (optional)
|
|
243
|
-
├── .github/
|
|
244
|
-
│ └── workflows/ # GitHub Actions workflows
|
|
245
|
-
├── .gitlab-ci.yml # GitLab CI/CD pipeline
|
|
246
|
-
├── package.json
|
|
247
|
-
├── .yarnrc.yml
|
|
248
|
-
└── README.md
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
---
|
|
252
|
-
|
|
253
|
-
## Environment Variables
|
|
254
|
-
|
|
255
|
-
The following environment variables are commonly used in Seeka apps:
|
|
256
|
-
|
|
257
|
-
| Variable | Description |
|
|
258
|
-
|----------|-------------|
|
|
259
|
-
| `SEEKA_APP_ID` | Your Seeka App ID (from https://seeka.app/settings/developer/apps) |
|
|
260
|
-
| `SEEKA_APP_SECRET` | Your Seeka App Secret |
|
|
261
|
-
|
|
262
|
-
---
|
|
263
|
-
|
|
264
|
-
## Requirements
|
|
265
|
-
|
|
266
|
-
- Node.js 18 or later
|
|
267
|
-
- npm, yarn, or pnpm
|
|
268
|
-
|
|
269
|
-
---
|
|
270
|
-
|
|
271
|
-
## Related Packages
|
|
272
|
-
|
|
273
|
-
- [`@seeka-labs/cli-apps-azure`](https://www.npmjs.com/package/@seeka-labs/cli-apps-azure) - Azure-specific CLI for GitHub repository setup and environment management
|
|
274
|
-
|
|
275
|
-
---
|
|
276
|
-
|
|
277
|
-
## Support
|
|
278
|
-
|
|
279
|
-
- [Seeka Developer Documentation](https://developers.seeka.co)
|
|
280
|
-
- [Seeka Platform](https://seeka.app)
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
## License
|
|
285
|
-
|
|
286
|
-
MIT
|