@omaikit/cli 0.1.4 → 0.1.6
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 +22 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<a href="https://omaicode.com">
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://omaicode.com/storage/app/media/images/omaicode_icon.png">
|
|
5
|
+
<img alt="Omaikit logo" src="https://omaicode.com/storage/app/media/images/omaicode_icon.png" height="64">
|
|
6
|
+
</picture>
|
|
7
|
+
</a>
|
|
8
|
+
<h1>Omaikit</h1>
|
|
9
|
+
|
|
10
|
+
<a href="https://www.npmjs.com/package/@omaikit/cli"><img alt="NPM version" src="https://img.shields.io/npm/v/@omaikit/cli.svg?style=for-the-badge&labelColor=000000"></a>
|
|
11
|
+
<a href="https://github.com/omaicode/omaikit/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@omaikit/cli.svg?style=for-the-badge&labelColor=000000"></a>
|
|
12
|
+
<a href="https://github.com/omaicode/omaikit/discussions"><img alt="Join the community on GitHub" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=GitHub&labelColor=000000&logoWidth=20"></a>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
1
15
|
## @omaikit/cli
|
|
2
16
|
|
|
3
17
|
Command-line interface for Omaikit. This package orchestrates planning, code generation, and test generation workflows.
|
|
@@ -5,7 +19,7 @@ Command-line interface for Omaikit. This package orchestrates planning, code gen
|
|
|
5
19
|
### Features
|
|
6
20
|
|
|
7
21
|
- `omaikit init` to generate `.omaikit/context.json`
|
|
8
|
-
- `omaikit plan` to create structured plans
|
|
22
|
+
- `omaikit plan` to create structured plans into `.omaikit/plans/` and `.omaikit/tasks/`
|
|
9
23
|
- `omaikit code` to generate code into the project root
|
|
10
24
|
- `omaikit test` to generate tests into `.omaikit/tests`
|
|
11
25
|
|
|
@@ -13,8 +27,9 @@ Command-line interface for Omaikit. This package orchestrates planning, code gen
|
|
|
13
27
|
|
|
14
28
|
```bash
|
|
15
29
|
npm install -g @omaikit/cli
|
|
16
|
-
|
|
17
|
-
omaikit
|
|
30
|
+
cd my-project
|
|
31
|
+
omaikit init "Build a REST API with Express and MongoDB"
|
|
32
|
+
omaikit plan "Create a user authentication system"
|
|
18
33
|
omaikit code
|
|
19
34
|
omaikit test
|
|
20
35
|
```
|
|
@@ -25,9 +40,8 @@ omaikit test
|
|
|
25
40
|
- Tests: `.omaikit/tests/`
|
|
26
41
|
- Generated code: project root
|
|
27
42
|
|
|
28
|
-
###
|
|
43
|
+
### Configuration
|
|
29
44
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
```
|
|
45
|
+
The CLI uses OPENAI_API_KEY from environment variables for API access. Ensure you have it set before running commands.
|
|
46
|
+
|
|
47
|
+
It'll ask for the OPENAI_API_KEY configuration during `omaikit init`.
|