aerocoding 0.1.0 → 0.1.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 +79 -88
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AeroCoding CLI
|
|
2
2
|
|
|
3
|
-
Generate production-ready code from your UML diagrams
|
|
3
|
+
Generate production-ready code from your UML diagrams.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -10,126 +10,117 @@ npm install -g aerocoding
|
|
|
10
10
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
|
-
### 1. Login
|
|
14
|
-
|
|
15
|
-
Authenticate with your AeroCoding account:
|
|
16
|
-
|
|
17
13
|
```bash
|
|
14
|
+
# 1. Login (once)
|
|
18
15
|
aerocoding login
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
This will open your browser for OAuth Device Flow authentication.
|
|
22
|
-
|
|
23
|
-
### 2. Generate Code
|
|
24
16
|
|
|
25
|
-
|
|
17
|
+
# 2. Initialize project (once per project)
|
|
18
|
+
aerocoding init
|
|
26
19
|
|
|
27
|
-
|
|
28
|
-
aerocoding generate
|
|
20
|
+
# 3. Generate code (anytime)
|
|
21
|
+
aerocoding generate
|
|
29
22
|
```
|
|
30
23
|
|
|
31
24
|
## Commands
|
|
32
25
|
|
|
33
|
-
###
|
|
34
|
-
|
|
35
|
-
- `aerocoding login` - Authenticate with AeroCoding (OAuth Device Flow)
|
|
36
|
-
- `aerocoding logout` - Clear stored credentials
|
|
37
|
-
- `aerocoding whoami` - Show current authenticated user
|
|
38
|
-
|
|
39
|
-
### Code Generation
|
|
40
|
-
|
|
41
|
-
- `aerocoding generate` - Generate code from project schema
|
|
26
|
+
### `aerocoding login`
|
|
42
27
|
|
|
43
|
-
|
|
44
|
-
- `--project <id>` - Project ID (required)
|
|
45
|
-
- `--targets <targets...>` - Generation targets (e.g., `dotnet-entity typescript-interface`)
|
|
46
|
-
- `--entities <entities...>` - Filter by specific entities
|
|
47
|
-
- `--preset <preset>` - Architecture preset
|
|
48
|
-
- `--layers <layers...>` - Specific layers to generate
|
|
49
|
-
- `--output <dir>` - Output directory (default: `./generated`)
|
|
50
|
-
- `--preview` - Preview without writing files
|
|
51
|
-
|
|
52
|
-
### Project Management
|
|
53
|
-
|
|
54
|
-
- `aerocoding init` - Initialize config in current directory (coming soon)
|
|
55
|
-
- `aerocoding pull` - Pull schema from cloud (coming soon)
|
|
56
|
-
- `aerocoding status` - Show local schema status (coming soon)
|
|
57
|
-
|
|
58
|
-
## Examples
|
|
59
|
-
|
|
60
|
-
### Generate .NET entities only
|
|
28
|
+
Authenticate with your AeroCoding account. Opens browser for secure OAuth authentication.
|
|
61
29
|
|
|
62
30
|
```bash
|
|
63
|
-
aerocoding
|
|
31
|
+
aerocoding login
|
|
64
32
|
```
|
|
65
33
|
|
|
66
|
-
###
|
|
34
|
+
### `aerocoding init`
|
|
35
|
+
|
|
36
|
+
Interactive wizard to configure code generation for your project. Creates a `.aerocodingrc.json` config file.
|
|
67
37
|
|
|
68
38
|
```bash
|
|
69
|
-
aerocoding
|
|
70
|
-
--targets dotnet-entity dotnet-repository typescript-interface
|
|
39
|
+
aerocoding init
|
|
71
40
|
```
|
|
72
41
|
|
|
73
|
-
|
|
42
|
+
Options:
|
|
43
|
+
- `-p, --project <id>` - Skip project selection
|
|
44
|
+
- `-f, --force` - Overwrite existing config
|
|
74
45
|
|
|
75
|
-
|
|
76
|
-
aerocoding gen --project abc123 \
|
|
77
|
-
--targets dotnet-entity \
|
|
78
|
-
--entities User Product Order
|
|
79
|
-
```
|
|
46
|
+
### `aerocoding generate`
|
|
80
47
|
|
|
81
|
-
|
|
48
|
+
Generate code based on your config file or CLI options.
|
|
82
49
|
|
|
83
50
|
```bash
|
|
84
|
-
|
|
85
|
-
|
|
51
|
+
# Using config file (recommended)
|
|
52
|
+
aerocoding generate
|
|
86
53
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
54
|
+
# With CLI overrides
|
|
55
|
+
aerocoding generate --no-testing
|
|
56
|
+
aerocoding generate -y # Skip confirmation
|
|
57
|
+
```
|
|
90
58
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
59
|
+
Options:
|
|
60
|
+
- `-p, --project <id>` - Project ID (overrides config)
|
|
61
|
+
- `-t, --targets <targets...>` - Generation targets
|
|
62
|
+
- `-o, --output <dir>` - Output directory (default: `./generated`)
|
|
63
|
+
- `--backend-preset <preset>` - Backend architecture preset
|
|
64
|
+
- `--frontend-preset <preset>` - Frontend architecture preset
|
|
65
|
+
- `--backend-layers <layers...>` - Backend layers to generate
|
|
66
|
+
- `--frontend-layers <layers...>` - Frontend layers to generate
|
|
67
|
+
- `--no-validations` - Exclude validation code
|
|
68
|
+
- `--no-comments` - Exclude comments
|
|
69
|
+
- `--no-annotations` - Exclude annotations/decorators
|
|
70
|
+
- `--no-logging` - Exclude logging
|
|
71
|
+
- `--no-testing` - Exclude test files
|
|
72
|
+
- `--validation-lib <lib>` - Validation library (e.g., `fluentvalidation`, `zod`)
|
|
73
|
+
- `-y, --yes` - Skip confirmation prompt
|
|
74
|
+
|
|
75
|
+
### `aerocoding whoami`
|
|
76
|
+
|
|
77
|
+
Show current authenticated user.
|
|
78
|
+
|
|
79
|
+
### `aerocoding logout`
|
|
80
|
+
|
|
81
|
+
Clear stored credentials.
|
|
82
|
+
|
|
83
|
+
## Config File
|
|
84
|
+
|
|
85
|
+
The `aerocoding init` command creates a `.aerocodingrc.json` file:
|
|
86
|
+
|
|
87
|
+
```json
|
|
88
|
+
{
|
|
89
|
+
"$schema": "https://aerocoding.app/schemas/aerocodingrc.json",
|
|
90
|
+
"project": "your-project-id",
|
|
91
|
+
"output": "./generated",
|
|
92
|
+
"backend": {
|
|
93
|
+
"preset": "clean-architecture-dotnet",
|
|
94
|
+
"layers": ["entities", "dtos", "validators", "repositories"]
|
|
95
|
+
},
|
|
96
|
+
"frontend": {
|
|
97
|
+
"preset": "feature-based",
|
|
98
|
+
"layers": ["models", "services"]
|
|
99
|
+
},
|
|
100
|
+
"codeStyle": {
|
|
101
|
+
"includeValidations": true,
|
|
102
|
+
"includeComments": true,
|
|
103
|
+
"includeAnnotations": true,
|
|
104
|
+
"includeLogging": true,
|
|
105
|
+
"includeTesting": false
|
|
106
|
+
}
|
|
107
|
+
}
|
|
95
108
|
```
|
|
96
109
|
|
|
110
|
+
CLI arguments override config file values.
|
|
111
|
+
|
|
97
112
|
## Security
|
|
98
113
|
|
|
99
|
-
|
|
114
|
+
Credentials are stored securely in your OS credential manager:
|
|
100
115
|
|
|
101
116
|
- **macOS**: Keychain
|
|
102
117
|
- **Windows**: Credential Manager
|
|
103
|
-
- **Linux**: Secret Service API
|
|
104
|
-
|
|
105
|
-
## Troubleshooting
|
|
106
|
-
|
|
107
|
-
### Not authenticated
|
|
108
|
-
|
|
109
|
-
If you see "Not authenticated", run:
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
aerocoding logout
|
|
113
|
-
aerocoding login
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Token expired
|
|
117
|
-
|
|
118
|
-
Tokens are automatically refreshed. If refresh fails:
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
aerocoding login
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Network errors
|
|
125
|
-
|
|
126
|
-
Check your API URL configuration and internet connection.
|
|
118
|
+
- **Linux**: Secret Service API
|
|
127
119
|
|
|
128
120
|
## Links
|
|
129
121
|
|
|
130
|
-
- [
|
|
131
|
-
- [
|
|
132
|
-
- [Website](https://aerocoding.dev)
|
|
122
|
+
- [Website](https://aerocoding.app)
|
|
123
|
+
- [Documentation](https://docs.aerocoding.app)
|
|
133
124
|
|
|
134
125
|
## License
|
|
135
126
|
|