@aicgen/aicgen 1.0.0-beta.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/.claude/agents/architecture-reviewer.md +88 -0
- package/.claude/agents/guideline-checker.md +73 -0
- package/.claude/agents/security-auditor.md +108 -0
- package/.claude/guidelines/api-design.md +645 -0
- package/.claude/guidelines/architecture.md +2503 -0
- package/.claude/guidelines/best-practices.md +618 -0
- package/.claude/guidelines/code-style.md +304 -0
- package/.claude/guidelines/design-patterns.md +573 -0
- package/.claude/guidelines/devops.md +226 -0
- package/.claude/guidelines/error-handling.md +413 -0
- package/.claude/guidelines/language.md +782 -0
- package/.claude/guidelines/performance.md +706 -0
- package/.claude/guidelines/security.md +583 -0
- package/.claude/guidelines/testing.md +568 -0
- package/.claude/settings.json +98 -0
- package/.claude/settings.local.json +8 -0
- package/.env.example +23 -0
- package/.eslintrc.json +28 -0
- package/.github/workflows/release.yml +180 -0
- package/.github/workflows/test.yml +81 -0
- package/.gitmodules +3 -0
- package/.vs/ProjectSettings.json +3 -0
- package/.vs/VSWorkspaceState.json +16 -0
- package/.vs/aicgen.slnx/FileContentIndex/5f0ce2a3-fd68-4863-9e23-e428cf1794e3.vsidx +0 -0
- package/.vs/aicgen.slnx/v18/.wsuo +0 -0
- package/.vs/aicgen.slnx/v18/DocumentLayout.json +54 -0
- package/.vs/slnx.sqlite +0 -0
- package/AGENTS.md +121 -0
- package/CLAUDE.md +36 -0
- package/CONTRIBUTING.md +821 -0
- package/LICENSE +21 -0
- package/README.md +199 -0
- package/assets/icon.svg +34 -0
- package/assets/logo.svg +41 -0
- package/bun.lock +848 -0
- package/data/LICENSE +21 -0
- package/data/README.md +203 -0
- package/data/api/basics.md +292 -0
- package/data/api/index.md +8 -0
- package/data/api/pagination.md +142 -0
- package/data/api/rest.md +137 -0
- package/data/api/versioning.md +60 -0
- package/data/architecture/clean-architecture/index.md +7 -0
- package/data/architecture/clean-architecture/layers.md +111 -0
- package/data/architecture/ddd/index.md +8 -0
- package/data/architecture/ddd/strategic.md +89 -0
- package/data/architecture/ddd/tactical.md +132 -0
- package/data/architecture/event-driven/index.md +7 -0
- package/data/architecture/event-driven/messaging.md +242 -0
- package/data/architecture/event-driven/patterns.md +129 -0
- package/data/architecture/feature-toggles/index.md +7 -0
- package/data/architecture/feature-toggles/patterns.md +73 -0
- package/data/architecture/gui/index.md +7 -0
- package/data/architecture/gui/patterns.md +132 -0
- package/data/architecture/hexagonal/ports-adapters.md +132 -0
- package/data/architecture/index.md +12 -0
- package/data/architecture/layered/index.md +7 -0
- package/data/architecture/layered/layers.md +100 -0
- package/data/architecture/microservices/api-gateway.md +56 -0
- package/data/architecture/microservices/boundaries.md +80 -0
- package/data/architecture/microservices/communication.md +97 -0
- package/data/architecture/microservices/data.md +92 -0
- package/data/architecture/microservices/index.md +11 -0
- package/data/architecture/microservices/resilience.md +111 -0
- package/data/architecture/modular-monolith/boundaries.md +133 -0
- package/data/architecture/modular-monolith/structure.md +131 -0
- package/data/architecture/serverless/best-practices.md +322 -0
- package/data/architecture/serverless/index.md +7 -0
- package/data/architecture/serverless/patterns.md +80 -0
- package/data/architecture/solid/index.md +7 -0
- package/data/architecture/solid/principles.md +187 -0
- package/data/database/basics.md +365 -0
- package/data/database/design-patterns.md +68 -0
- package/data/database/index.md +8 -0
- package/data/database/indexing.md +136 -0
- package/data/database/nosql.md +223 -0
- package/data/database/schema.md +137 -0
- package/data/devops/ci-cd.md +66 -0
- package/data/devops/index.md +8 -0
- package/data/devops/observability.md +73 -0
- package/data/devops/practices.md +77 -0
- package/data/error-handling/basics.md +222 -0
- package/data/error-handling/index.md +7 -0
- package/data/error-handling/strategy.md +185 -0
- package/data/guideline-mappings.yml +1077 -0
- package/data/index.md +3 -0
- package/data/language/csharp/basics.md +210 -0
- package/data/language/csharp/testing.md +252 -0
- package/data/language/go/basics.md +158 -0
- package/data/language/go/testing.md +192 -0
- package/data/language/index.md +14 -0
- package/data/language/java/basics.md +184 -0
- package/data/language/java/testing.md +273 -0
- package/data/language/javascript/basics.md +217 -0
- package/data/language/javascript/testing.md +269 -0
- package/data/language/python/async.md +100 -0
- package/data/language/python/basics.md +100 -0
- package/data/language/python/index.md +10 -0
- package/data/language/python/testing.md +125 -0
- package/data/language/python/types.md +99 -0
- package/data/language/ruby/basics.md +227 -0
- package/data/language/ruby/testing.md +267 -0
- package/data/language/rust/basics.md +175 -0
- package/data/language/rust/testing.md +219 -0
- package/data/language/typescript/async.md +103 -0
- package/data/language/typescript/basics.md +87 -0
- package/data/language/typescript/config.md +95 -0
- package/data/language/typescript/error-handling.md +98 -0
- package/data/language/typescript/generics.md +85 -0
- package/data/language/typescript/index.md +14 -0
- package/data/language/typescript/interfaces-types.md +83 -0
- package/data/language/typescript/performance.md +103 -0
- package/data/language/typescript/testing.md +98 -0
- package/data/patterns/base-patterns.md +105 -0
- package/data/patterns/concurrency.md +87 -0
- package/data/patterns/data-access.md +83 -0
- package/data/patterns/distribution.md +86 -0
- package/data/patterns/domain-logic.md +81 -0
- package/data/patterns/gof.md +109 -0
- package/data/patterns/index.md +12 -0
- package/data/performance/async.md +148 -0
- package/data/performance/basics.md +324 -0
- package/data/performance/caching-strategies.md +68 -0
- package/data/performance/caching.md +152 -0
- package/data/performance/index.md +8 -0
- package/data/practices/code-review.md +52 -0
- package/data/practices/documentation.md +260 -0
- package/data/practices/index.md +11 -0
- package/data/practices/planning.md +142 -0
- package/data/practices/refactoring.md +91 -0
- package/data/practices/version-control.md +55 -0
- package/data/security/auth-jwt.md +159 -0
- package/data/security/headers.md +143 -0
- package/data/security/index.md +10 -0
- package/data/security/injection.md +119 -0
- package/data/security/secrets.md +148 -0
- package/data/style/index.md +8 -0
- package/data/style/naming.md +136 -0
- package/data/style/organization.md +162 -0
- package/data/templates/agents/architecture-reviewer.md +88 -0
- package/data/templates/agents/guideline-checker.md +73 -0
- package/data/templates/agents/security-auditor.md +108 -0
- package/data/templates/antigravity/rules/architecture.md.hbs +5 -0
- package/data/templates/antigravity/rules/code-style.md.hbs +5 -0
- package/data/templates/antigravity/rules/language.md.hbs +5 -0
- package/data/templates/antigravity/rules/performance.md.hbs +5 -0
- package/data/templates/antigravity/rules/security.md.hbs +5 -0
- package/data/templates/antigravity/rules/testing.md.hbs +5 -0
- package/data/templates/antigravity/workflows/add-documentation.md.hbs +23 -0
- package/data/templates/antigravity/workflows/generate-integration-tests.md.hbs +17 -0
- package/data/templates/antigravity/workflows/generate-unit-tests.md.hbs +20 -0
- package/data/templates/antigravity/workflows/performance-audit.md.hbs +24 -0
- package/data/templates/antigravity/workflows/refactor-extract-module.md.hbs +17 -0
- package/data/templates/antigravity/workflows/security-audit.md.hbs +20 -0
- package/data/templates/hooks/formatting.json +26 -0
- package/data/templates/hooks/security.json +35 -0
- package/data/templates/hooks/testing.json +17 -0
- package/data/testing/basics.md +151 -0
- package/data/testing/index.md +9 -0
- package/data/testing/integration.md +159 -0
- package/data/testing/unit-fundamentals.md +128 -0
- package/data/testing/unit-mocking.md +116 -0
- package/data/version.json +49 -0
- package/dist/commands/init.d.ts +8 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +46 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/config/profiles.d.ts +4 -0
- package/dist/config/profiles.d.ts.map +1 -0
- package/dist/config/profiles.js +30 -0
- package/dist/config/profiles.js.map +1 -0
- package/dist/config/settings.d.ts +7 -0
- package/dist/config/settings.d.ts.map +1 -0
- package/dist/config/settings.js +7 -0
- package/dist/config/settings.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +58489 -0
- package/dist/index.js.map +1 -0
- package/dist/models/guideline.d.ts +15 -0
- package/dist/models/guideline.d.ts.map +1 -0
- package/dist/models/guideline.js +2 -0
- package/dist/models/guideline.js.map +1 -0
- package/dist/models/preference.d.ts +9 -0
- package/dist/models/preference.d.ts.map +1 -0
- package/dist/models/preference.js +2 -0
- package/dist/models/preference.js.map +1 -0
- package/dist/models/profile.d.ts +9 -0
- package/dist/models/profile.d.ts.map +1 -0
- package/dist/models/profile.js +2 -0
- package/dist/models/profile.js.map +1 -0
- package/dist/models/project.d.ts +13 -0
- package/dist/models/project.d.ts.map +1 -0
- package/dist/models/project.js +2 -0
- package/dist/models/project.js.map +1 -0
- package/dist/services/ai/anthropic.d.ts +7 -0
- package/dist/services/ai/anthropic.d.ts.map +1 -0
- package/dist/services/ai/anthropic.js +39 -0
- package/dist/services/ai/anthropic.js.map +1 -0
- package/dist/services/generator.d.ts +2 -0
- package/dist/services/generator.d.ts.map +1 -0
- package/dist/services/generator.js +4 -0
- package/dist/services/generator.js.map +1 -0
- package/dist/services/learner.d.ts +2 -0
- package/dist/services/learner.d.ts.map +1 -0
- package/dist/services/learner.js +4 -0
- package/dist/services/learner.js.map +1 -0
- package/dist/services/scanner.d.ts +3 -0
- package/dist/services/scanner.d.ts.map +1 -0
- package/dist/services/scanner.js +54 -0
- package/dist/services/scanner.js.map +1 -0
- package/dist/utils/errors.d.ts +15 -0
- package/dist/utils/errors.d.ts.map +1 -0
- package/dist/utils/errors.js +27 -0
- package/dist/utils/errors.js.map +1 -0
- package/dist/utils/file.d.ts +7 -0
- package/dist/utils/file.d.ts.map +1 -0
- package/dist/utils/file.js +32 -0
- package/dist/utils/file.js.map +1 -0
- package/dist/utils/logger.d.ts +6 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +17 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/path.d.ts +6 -0
- package/dist/utils/path.d.ts.map +1 -0
- package/dist/utils/path.js +14 -0
- package/dist/utils/path.js.map +1 -0
- package/docs/planning/memory-lane.md +83 -0
- package/package.json +64 -0
- package/packaging/linux/aicgen.spec +23 -0
- package/packaging/linux/control +9 -0
- package/packaging/macos/scripts/postinstall +12 -0
- package/packaging/windows/setup.nsi +92 -0
- package/planning/BRANDING-SUMMARY.md +194 -0
- package/planning/BRANDING.md +174 -0
- package/planning/BUILD.md +186 -0
- package/planning/CHUNK-IMPLEMENTATION-PLAN.md +87 -0
- package/planning/CHUNK-TAXONOMY.md +375 -0
- package/planning/CHUNKS-COMPLETE.md +382 -0
- package/planning/DESIGN.md +313 -0
- package/planning/DYNAMIC-GUIDELINES-DESIGN.md +265 -0
- package/planning/ENTERPRISE-UX-COMPLETE.md +281 -0
- package/planning/IMPLEMENTATION-PLAN.md +20 -0
- package/planning/PHASE1-COMPLETE.md +211 -0
- package/planning/PHASE2-COMPLETE.md +350 -0
- package/planning/PHASE3-COMPLETE.md +399 -0
- package/planning/PHASE4-COMPLETE.md +361 -0
- package/planning/PHASE4.5-CHUNKS.md +462 -0
- package/planning/STRUCTURE.md +170 -0
- package/scripts/add-categories.ts +87 -0
- package/scripts/build-binary.ts +46 -0
- package/scripts/embed-data.ts +105 -0
- package/scripts/generate-version.ts +150 -0
- package/scripts/test-decompress.ts +27 -0
- package/scripts/test-extract.ts +31 -0
- package/src/__tests__/services/assistant-file-writer.test.ts +400 -0
- package/src/__tests__/services/guideline-loader.test.ts +281 -0
- package/src/__tests__/services/tarball-extraction.test.ts +125 -0
- package/src/commands/add-guideline.ts +296 -0
- package/src/commands/clear.ts +61 -0
- package/src/commands/guideline-selector.ts +123 -0
- package/src/commands/init.ts +645 -0
- package/src/commands/quick-add.ts +586 -0
- package/src/commands/remove-guideline.ts +152 -0
- package/src/commands/stats.ts +49 -0
- package/src/commands/update.ts +240 -0
- package/src/config.ts +82 -0
- package/src/embedded-data.ts +1492 -0
- package/src/index.ts +67 -0
- package/src/models/profile.ts +24 -0
- package/src/models/project.ts +43 -0
- package/src/services/assistant-file-writer.ts +612 -0
- package/src/services/config-generator.ts +150 -0
- package/src/services/config-manager.ts +70 -0
- package/src/services/data-source.ts +248 -0
- package/src/services/first-run-init.ts +148 -0
- package/src/services/guideline-loader.ts +311 -0
- package/src/services/hook-generator.ts +178 -0
- package/src/services/subagent-generator.ts +310 -0
- package/src/utils/banner.ts +66 -0
- package/src/utils/errors.ts +27 -0
- package/src/utils/file.ts +67 -0
- package/src/utils/formatting.ts +172 -0
- package/src/utils/logger.ts +89 -0
- package/src/utils/path.ts +17 -0
- package/src/utils/wizard-state.ts +132 -0
- package/tsconfig.json +25 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
# MacOS Post-install script
|
|
3
|
+
|
|
4
|
+
# Ensure /usr/local/bin exists
|
|
5
|
+
if [ ! -d "/usr/local/bin" ]; then
|
|
6
|
+
mkdir -p "/usr/local/bin"
|
|
7
|
+
fi
|
|
8
|
+
|
|
9
|
+
# Link is handled by pkgbuild usually, but we can double check permission
|
|
10
|
+
chmod +x "/usr/local/bin/aicgen"
|
|
11
|
+
|
|
12
|
+
exit 0
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
; aicgen Installer Script
|
|
2
|
+
!include "MUI2.nsh"
|
|
3
|
+
|
|
4
|
+
; General
|
|
5
|
+
Name "aicgen"
|
|
6
|
+
OutFile "..\..\dist\aicgen-setup-x64.exe"
|
|
7
|
+
Unicode True
|
|
8
|
+
InstallDir "$PROGRAMFILES64\aicgen"
|
|
9
|
+
InstallDirRegKey HKCU "Software\aicgen" ""
|
|
10
|
+
RequestExecutionLevel admin
|
|
11
|
+
|
|
12
|
+
; Version Information
|
|
13
|
+
VIProductVersion "1.0.0.0"
|
|
14
|
+
VIAddVersionKey "ProductName" "aicgen"
|
|
15
|
+
VIAddVersionKey "CompanyName" "lpsandaruwan"
|
|
16
|
+
VIAddVersionKey "LegalCopyright" "© 2025 lpsandaruwan"
|
|
17
|
+
VIAddVersionKey "FileDescription" "AI Config Generator Installer"
|
|
18
|
+
VIAddVersionKey "FileVersion" "1.0.0.0"
|
|
19
|
+
|
|
20
|
+
; Icons (Uncomment if .ico files are present in packaging/windows)
|
|
21
|
+
; !define MUI_ICON "install.ico"
|
|
22
|
+
; !define MUI_UNICON "uninstall.ico"
|
|
23
|
+
|
|
24
|
+
; UI Interface
|
|
25
|
+
!define MUI_ABORTWARNING
|
|
26
|
+
!insertmacro MUI_PAGE_WELCOME
|
|
27
|
+
!insertmacro MUI_PAGE_LICENSE "..\..\LICENSE"
|
|
28
|
+
!insertmacro MUI_PAGE_DIRECTORY
|
|
29
|
+
!insertmacro MUI_PAGE_INSTFILES
|
|
30
|
+
!insertmacro MUI_PAGE_FINISH
|
|
31
|
+
|
|
32
|
+
!insertmacro MUI_UNPAGE_WELCOME
|
|
33
|
+
!insertmacro MUI_UNPAGE_CONFIRM
|
|
34
|
+
!insertmacro MUI_UNPAGE_INSTFILES
|
|
35
|
+
!insertmacro MUI_UNPAGE_FINISH
|
|
36
|
+
|
|
37
|
+
!insertmacro MUI_LANGUAGE "English"
|
|
38
|
+
|
|
39
|
+
; Installer
|
|
40
|
+
Section "aicgen (required)" SecCore
|
|
41
|
+
SectionIn RO
|
|
42
|
+
|
|
43
|
+
SetOutPath "$INSTDIR"
|
|
44
|
+
|
|
45
|
+
; Files to install
|
|
46
|
+
File "..\..\dist\aicgen.exe"
|
|
47
|
+
File "..\..\LICENSE"
|
|
48
|
+
File "..\..\README.md"
|
|
49
|
+
|
|
50
|
+
; Write Uninstaller
|
|
51
|
+
WriteUninstaller "$INSTDIR\uninstall.exe"
|
|
52
|
+
|
|
53
|
+
; Start Menu Shortcuts
|
|
54
|
+
CreateDirectory "$SMPROGRAMS\aicgen"
|
|
55
|
+
CreateShortcut "$SMPROGRAMS\aicgen\aicgen.lnk" "$INSTDIR\aicgen.exe"
|
|
56
|
+
CreateShortcut "$SMPROGRAMS\aicgen\Uninstall.lnk" "$INSTDIR\uninstall.exe"
|
|
57
|
+
|
|
58
|
+
; Registry keys for Add/Remove programs
|
|
59
|
+
WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\aicgen" "DisplayName" "aicgen"
|
|
60
|
+
WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\aicgen" "UninstallString" '"$INSTDIR\uninstall.exe"'
|
|
61
|
+
WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\aicgen" "Publisher" "lpsandaruwan"
|
|
62
|
+
WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\aicgen" "DisplayVersion" "1.0.0"
|
|
63
|
+
|
|
64
|
+
; Add to PATH
|
|
65
|
+
EnVar::SetHKLM
|
|
66
|
+
EnVar::AddValue "path" "$INSTDIR"
|
|
67
|
+
SectionEnd
|
|
68
|
+
|
|
69
|
+
; Uninstaller
|
|
70
|
+
Section "Uninstall"
|
|
71
|
+
; Remove files
|
|
72
|
+
Delete "$INSTDIR\aicgen.exe"
|
|
73
|
+
Delete "$INSTDIR\LICENSE"
|
|
74
|
+
Delete "$INSTDIR\README.md"
|
|
75
|
+
Delete "$INSTDIR\uninstall.exe"
|
|
76
|
+
|
|
77
|
+
; Remove shortcuts
|
|
78
|
+
Delete "$SMPROGRAMS\aicgen\aicgen.lnk"
|
|
79
|
+
Delete "$SMPROGRAMS\aicgen\Uninstall.lnk"
|
|
80
|
+
RMDir "$SMPROGRAMS\aicgen"
|
|
81
|
+
|
|
82
|
+
; Remove install dir
|
|
83
|
+
RMDir "$INSTDIR"
|
|
84
|
+
|
|
85
|
+
; Remove from PATH
|
|
86
|
+
EnVar::SetHKLM
|
|
87
|
+
EnVar::DeleteValue "path" "$INSTDIR"
|
|
88
|
+
|
|
89
|
+
; Remove registry keys
|
|
90
|
+
DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\aicgen"
|
|
91
|
+
DeleteRegKey HKCU "Software\aicgen"
|
|
92
|
+
SectionEnd
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# Branding Implementation Complete ✅
|
|
2
|
+
|
|
3
|
+
## What Was Created
|
|
4
|
+
|
|
5
|
+
### 1. SVG Logo (`assets/logo.svg`)
|
|
6
|
+
- **Design**: Abstract AI → Config transformation
|
|
7
|
+
- **Colors**: Cyan (#06b6d4) → Purple (#a855f7) gradient
|
|
8
|
+
- **Features**:
|
|
9
|
+
- Neural network nodes (left)
|
|
10
|
+
- Flow arrows (center)
|
|
11
|
+
- Document shapes (right)
|
|
12
|
+
- Animated sparkle particles
|
|
13
|
+
- Glow effects
|
|
14
|
+
- **Size**: 400x400px, scalable vector
|
|
15
|
+
- **Use**: README, docs, web, social media
|
|
16
|
+
|
|
17
|
+
### 2. ASCII Art Logo (`assets/logo-ascii.txt`)
|
|
18
|
+
- **Versions**:
|
|
19
|
+
- Large (main banner)
|
|
20
|
+
- Medium (compact)
|
|
21
|
+
- Small (inline)
|
|
22
|
+
- Minimal (loading)
|
|
23
|
+
- **Colors**: Cyan nodes → Purple docs (with chalk)
|
|
24
|
+
- **Use**: Terminal display
|
|
25
|
+
|
|
26
|
+
### 3. Banner Utility (`src/utils/banner.ts`)
|
|
27
|
+
Functions:
|
|
28
|
+
```typescript
|
|
29
|
+
showBanner() // Full logo + version
|
|
30
|
+
showInstructions() // Navigation help
|
|
31
|
+
showCheckboxInstructions() // Checkbox tips
|
|
32
|
+
getLogoPrefix(animated?) // Small animated logo
|
|
33
|
+
showSmallLogo() // Compact version
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 4. Updated Files
|
|
37
|
+
- `README.md` - Logo header, updated features, guidelines system
|
|
38
|
+
- `src/commands/init.ts` - Now shows banner at start
|
|
39
|
+
- `assets/README.md` - Complete branding guide
|
|
40
|
+
- `BRANDING.md` - Usage documentation
|
|
41
|
+
|
|
42
|
+
## Visual Output
|
|
43
|
+
|
|
44
|
+
### Terminal Banner (when running `aicgen init`)
|
|
45
|
+
```
|
|
46
|
+
● ╱╲
|
|
47
|
+
● ╲ ╱ ╲ ╭─────────╮
|
|
48
|
+
● ╲ ╱ ╲ │ ≡≡≡≡≡≡ │
|
|
49
|
+
● ╲╱ ▶▶ ╲ │ ≡≡≡≡ │
|
|
50
|
+
● ╱╲ ╱ │ ≡≡≡≡≡ │
|
|
51
|
+
╱ ╲ ╱ ╰─────────╯
|
|
52
|
+
╲╱ ✓
|
|
53
|
+
|
|
54
|
+
aicgen · AI Config Generator
|
|
55
|
+
|
|
56
|
+
Version 0.1.0 · MIT License
|
|
57
|
+
|
|
58
|
+
Navigation:
|
|
59
|
+
↑↓ arrows - Navigate options
|
|
60
|
+
Space - Select/deselect (checkboxes)
|
|
61
|
+
Enter - Confirm selection
|
|
62
|
+
Ctrl+C - Cancel anytime
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### README Header (on GitHub)
|
|
66
|
+
```markdown
|
|
67
|
+
[Logo Image - centered]
|
|
68
|
+
|
|
69
|
+
aicgen
|
|
70
|
+
AI Config Generator
|
|
71
|
+
|
|
72
|
+
Enterprise-grade configuration generator for AI coding assistants
|
|
73
|
+
|
|
74
|
+
[Version Badge] [License Badge] [Bun Badge]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Loading States
|
|
78
|
+
```
|
|
79
|
+
◉ ▶ ▢ Generating... (frame 1)
|
|
80
|
+
◉ ▶▶ ▢ Generating... (frame 2)
|
|
81
|
+
◉ ▶▶▶ ▣ Generating... (frame 3)
|
|
82
|
+
◉ ▶ ✓ Generated! (frame 4)
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Color Palette
|
|
86
|
+
|
|
87
|
+
### Primary
|
|
88
|
+
- **Cyan**: `#06b6d4` - Technology, terminals, code
|
|
89
|
+
- **Purple**: `#a855f7` - AI, intelligence, creativity
|
|
90
|
+
|
|
91
|
+
### Accent
|
|
92
|
+
- **White**: `#ffffff` - Text, emphasis
|
|
93
|
+
- **Gray**: `#6b7280` - Secondary text
|
|
94
|
+
- **Green**: `#10b981` - Success states
|
|
95
|
+
|
|
96
|
+
### Usage in Code
|
|
97
|
+
```typescript
|
|
98
|
+
import chalk from 'chalk';
|
|
99
|
+
|
|
100
|
+
console.log(chalk.cyan('●')); // Nodes
|
|
101
|
+
console.log(chalk.magenta('▶▶')); // Flow
|
|
102
|
+
console.log(chalk.gray('≡≡≡')); // Code lines
|
|
103
|
+
console.log(chalk.green('✓')); // Success
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Integration Points
|
|
107
|
+
|
|
108
|
+
### Current Usage
|
|
109
|
+
- ✅ `init` command shows banner on start
|
|
110
|
+
- ✅ README displays logo and branding
|
|
111
|
+
- ✅ Navigation instructions shown to users
|
|
112
|
+
- ✅ Checkbox help with logo tip
|
|
113
|
+
|
|
114
|
+
### Future Usage Opportunities
|
|
115
|
+
- Loading spinners with logo prefix
|
|
116
|
+
- Error messages with logo
|
|
117
|
+
- Success confirmations with logo
|
|
118
|
+
- Stats command output
|
|
119
|
+
- Help command branding
|
|
120
|
+
|
|
121
|
+
## Files Created
|
|
122
|
+
|
|
123
|
+
1. `assets/logo.svg` - Full color vector logo
|
|
124
|
+
2. `assets/logo-ascii.txt` - All ASCII art versions
|
|
125
|
+
3. `assets/README.md` - Branding guidelines
|
|
126
|
+
4. `src/utils/banner.ts` - Banner utility functions
|
|
127
|
+
5. `BRANDING.md` - Implementation documentation
|
|
128
|
+
6. `BRANDING-SUMMARY.md` - This file
|
|
129
|
+
|
|
130
|
+
## Files Modified
|
|
131
|
+
|
|
132
|
+
1. `README.md` - Added logo, updated features
|
|
133
|
+
2. `src/commands/init.ts` - Added banner imports and display
|
|
134
|
+
|
|
135
|
+
## TypeScript Compilation
|
|
136
|
+
|
|
137
|
+
✅ All code compiles successfully
|
|
138
|
+
```bash
|
|
139
|
+
npx tsc --noEmit
|
|
140
|
+
# No errors
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Testing
|
|
144
|
+
|
|
145
|
+
To test the branding:
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
# Build binary
|
|
149
|
+
bun run build:binary:windows
|
|
150
|
+
|
|
151
|
+
# Run init to see banner
|
|
152
|
+
./aicgen.exe init
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Expected output:
|
|
156
|
+
1. ASCII logo with cyan/purple colors
|
|
157
|
+
2. Version and license info
|
|
158
|
+
3. Navigation instructions
|
|
159
|
+
4. Continues to wizard...
|
|
160
|
+
|
|
161
|
+
## Design Philosophy
|
|
162
|
+
|
|
163
|
+
**Modern & Technical**: Reflects CLI tool nature
|
|
164
|
+
**Abstract & Clean**: Professional, not playful
|
|
165
|
+
**Gradient Flow**: Represents transformation
|
|
166
|
+
**Recognizable**: Works at any size
|
|
167
|
+
|
|
168
|
+
## Impact
|
|
169
|
+
|
|
170
|
+
### User Experience
|
|
171
|
+
- ✅ Professional first impression
|
|
172
|
+
- ✅ Clear brand identity
|
|
173
|
+
- ✅ Helpful navigation guidance
|
|
174
|
+
- ✅ Consistent visual language
|
|
175
|
+
|
|
176
|
+
### Marketing
|
|
177
|
+
- ✅ GitHub-ready README with logo
|
|
178
|
+
- ✅ Social media sharing image
|
|
179
|
+
- ✅ Professional appearance for adoption
|
|
180
|
+
- ✅ Memorable visual identity
|
|
181
|
+
|
|
182
|
+
## Next Steps (Optional Future Enhancements)
|
|
183
|
+
|
|
184
|
+
1. **Favicon** - Export 32x32, 64x64 for web
|
|
185
|
+
2. **Social Card** - 1200x630 for Twitter/OG
|
|
186
|
+
3. **Icon Pack** - Various sizes for installers
|
|
187
|
+
4. **Animated GIF** - Terminal recording for README
|
|
188
|
+
5. **More loading states** - Different operations with different animations
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
**Status**: ✅ Complete and production-ready
|
|
193
|
+
**Date**: 2025-12-08
|
|
194
|
+
**Version**: 0.1.0
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# aicgen Branding Implementation
|
|
2
|
+
|
|
3
|
+
## ✅ Completed
|
|
4
|
+
|
|
5
|
+
### 1. SVG Logo (`assets/logo.svg`)
|
|
6
|
+
|
|
7
|
+
**Design**: Abstract representation of AI → Config Generation
|
|
8
|
+
- Neural network nodes (left) representing AI intelligence
|
|
9
|
+
- Flow arrows showing transformation process
|
|
10
|
+
- Document shapes (right) representing generated config files
|
|
11
|
+
- Animated sparkle particles for dynamic feel
|
|
12
|
+
|
|
13
|
+
**Colors**:
|
|
14
|
+
- Primary: Cyan (`#06b6d4`) - Tech, terminals
|
|
15
|
+
- Accent: Purple/Magenta (`#a855f7`) - AI, creativity
|
|
16
|
+
- Gradient: Cyan → Purple - Transformation flow
|
|
17
|
+
|
|
18
|
+
**Features**:
|
|
19
|
+
- 400x400px scalable SVG
|
|
20
|
+
- Glow effects and animations
|
|
21
|
+
- Optimized for web/docs display
|
|
22
|
+
|
|
23
|
+
### 2. ASCII Art Versions (`assets/logo-ascii.txt`)
|
|
24
|
+
|
|
25
|
+
**Large** - Main banner:
|
|
26
|
+
```
|
|
27
|
+
● ╱╲
|
|
28
|
+
● ╲ ╱ ╲ ╭─────────╮
|
|
29
|
+
● ╲ ╱ ╲ │ ≡≡≡≡≡≡ │
|
|
30
|
+
● ╲╱ ▶▶ ╲ │ ≡≡≡≡ │
|
|
31
|
+
● ╱╲ ╱ │ ≡≡≡≡≡ │
|
|
32
|
+
╱ ╲ ╱ ╰─────────╯
|
|
33
|
+
╲╱ ✓
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Medium** - Compact banner:
|
|
37
|
+
```
|
|
38
|
+
●
|
|
39
|
+
● ╲ ╭──────╮
|
|
40
|
+
● ╲▶▶ │ ≡≡≡ │
|
|
41
|
+
● ╱ ╰──────╯
|
|
42
|
+
● ✓
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Small** - Status indicator:
|
|
46
|
+
```
|
|
47
|
+
●╲
|
|
48
|
+
● ╱▶ ▢
|
|
49
|
+
●╱
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**Minimal** - Loading animation:
|
|
53
|
+
```
|
|
54
|
+
◉ ▶ ▢ → ◉ ▶▶ ▢ → ◉ ▶▶▶ ▣ → ◉ ▶ ✓
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 3. Banner Utility (`src/utils/banner.ts`)
|
|
58
|
+
|
|
59
|
+
**Functions**:
|
|
60
|
+
- `showBanner()` - Full logo with name and version
|
|
61
|
+
- `showInstructions()` - Navigation help
|
|
62
|
+
- `showCheckboxInstructions()` - Checkbox-specific help
|
|
63
|
+
- `getLogoPrefix(animated?)` - Small animated logo for status
|
|
64
|
+
- `showSmallLogo()` - Compact version
|
|
65
|
+
|
|
66
|
+
**Implementation**:
|
|
67
|
+
```typescript
|
|
68
|
+
import { showBanner } from './utils/banner.js';
|
|
69
|
+
|
|
70
|
+
// Show at start of command
|
|
71
|
+
showBanner();
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**Output**:
|
|
75
|
+
```
|
|
76
|
+
● ╱╲
|
|
77
|
+
● ╲ ╱ ╲ ╭─────────╮
|
|
78
|
+
● ╲ ╱ ╲ │ ≡≡≡≡≡≡ │
|
|
79
|
+
● ╲╱ ▶▶ ╲ │ ≡≡≡≡ │
|
|
80
|
+
● ╱╲ ╱ │ ≡≡≡≡≡ │
|
|
81
|
+
╱ ╲ ╱ ╰─────────╯
|
|
82
|
+
╲╱ ✓
|
|
83
|
+
|
|
84
|
+
aicgen · AI Config Generator
|
|
85
|
+
|
|
86
|
+
Version 0.1.0 · MIT License
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### 4. Asset Documentation (`assets/README.md`)
|
|
90
|
+
|
|
91
|
+
Complete branding guidelines including:
|
|
92
|
+
- Logo concept explanation
|
|
93
|
+
- Color palette with hex codes
|
|
94
|
+
- Usage guidelines
|
|
95
|
+
- Export sizes
|
|
96
|
+
- Design philosophy
|
|
97
|
+
|
|
98
|
+
## Usage Examples
|
|
99
|
+
|
|
100
|
+
### Terminal Banner
|
|
101
|
+
```typescript
|
|
102
|
+
import { showBanner, showInstructions } from './utils/banner.js';
|
|
103
|
+
|
|
104
|
+
export async function initCommand() {
|
|
105
|
+
showBanner(); // Logo + branding
|
|
106
|
+
showInstructions(); // Navigation help
|
|
107
|
+
// ... rest of command
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Loading States
|
|
112
|
+
```typescript
|
|
113
|
+
import ora from 'ora';
|
|
114
|
+
import { getLogoPrefix } from './utils/banner.js';
|
|
115
|
+
|
|
116
|
+
const spinner = ora({
|
|
117
|
+
text: 'Generating configuration...',
|
|
118
|
+
prefixText: getLogoPrefix(true) // Animated logo
|
|
119
|
+
}).start();
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Status Messages
|
|
123
|
+
```typescript
|
|
124
|
+
console.log(`${getLogoPrefix()} Configuration ready!`);
|
|
125
|
+
// Output: ◉ ▶ ▢ Configuration ready!
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### README Header
|
|
129
|
+
```markdown
|
|
130
|
+
<p align="center">
|
|
131
|
+
<img src="assets/logo.svg" width="200" alt="aicgen" />
|
|
132
|
+
</p>
|
|
133
|
+
|
|
134
|
+
<h1 align="center">aicgen</h1>
|
|
135
|
+
<p align="center">AI Config Generator</p>
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Visual Identity
|
|
139
|
+
|
|
140
|
+
### Primary Palette
|
|
141
|
+
- **Cyan**: Technology, terminals, code
|
|
142
|
+
- **Purple**: AI, intelligence, automation
|
|
143
|
+
- **Gradient**: Transformation and flow
|
|
144
|
+
|
|
145
|
+
### Typography (Terminal)
|
|
146
|
+
- **Brand Name**: Bold white
|
|
147
|
+
- **Tagline**: Gray
|
|
148
|
+
- **Version**: Gray with separator
|
|
149
|
+
|
|
150
|
+
### Spacing
|
|
151
|
+
- Logo: 2 lines padding top/bottom
|
|
152
|
+
- Version: 1 line below logo
|
|
153
|
+
- Instructions: 1 line below version
|
|
154
|
+
|
|
155
|
+
## Future Enhancements
|
|
156
|
+
|
|
157
|
+
### Possible Additions:
|
|
158
|
+
1. **Favicon** - Export 32x32, 64x64 for web
|
|
159
|
+
2. **Social Cards** - 1200x630 for Twitter/OG tags
|
|
160
|
+
3. **Icon Pack** - Various sizes for installers
|
|
161
|
+
4. **Animated GIF** - For README showcase
|
|
162
|
+
5. **Terminal Recording** - Asciinema demo with branding
|
|
163
|
+
|
|
164
|
+
### Integration Points:
|
|
165
|
+
- Package manager listings (npm, cargo, etc.)
|
|
166
|
+
- Documentation sites
|
|
167
|
+
- GitHub social preview
|
|
168
|
+
- Installation screens
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
**Status**: ✅ Complete and integrated
|
|
173
|
+
**Files**: 4 created (SVG, ASCII, README, Implementation)
|
|
174
|
+
**Impact**: Professional, recognizable brand identity across all touchpoints
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# Build Instructions
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
|
|
5
|
+
- **Bun** >= 1.0.0 installed ([Download](https://bun.sh))
|
|
6
|
+
- Windows, Linux, or macOS
|
|
7
|
+
|
|
8
|
+
## Quick Build (Current Platform)
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
# Navigate to project
|
|
12
|
+
cd F:\aicgen\aicgen
|
|
13
|
+
|
|
14
|
+
# Install dependencies
|
|
15
|
+
bun install
|
|
16
|
+
|
|
17
|
+
# Build standalone executable
|
|
18
|
+
bun run build:binary
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
This will create `aicgen.exe` (on Windows) in the project root.
|
|
22
|
+
|
|
23
|
+
## Build for All Platforms
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Build for all platforms at once
|
|
27
|
+
bun run build:all
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
This creates:
|
|
31
|
+
- `aicgen.exe` (Windows)
|
|
32
|
+
- `aicgen-linux` (Linux x64)
|
|
33
|
+
- `aicgen-macos` (macOS ARM64)
|
|
34
|
+
|
|
35
|
+
## Step-by-Step Build Process
|
|
36
|
+
|
|
37
|
+
### 1. Install Dependencies
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
bun install
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 2. Pre-build (Generate Profile Files)
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
bun run prebuild
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
This runs `scripts/prebuild-profiles-chunks.ts` which validates the chunk system.
|
|
50
|
+
|
|
51
|
+
### 3. Type Check (Optional but Recommended)
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
bun run typecheck
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 4. Build Binary
|
|
58
|
+
|
|
59
|
+
**Windows:**
|
|
60
|
+
```bash
|
|
61
|
+
bun run build:binary:windows
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Linux:**
|
|
65
|
+
```bash
|
|
66
|
+
bun run build:binary:linux
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**macOS:**
|
|
70
|
+
```bash
|
|
71
|
+
bun run build:binary:macos
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Testing the Binary
|
|
75
|
+
|
|
76
|
+
### On Windows
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Test stats command
|
|
80
|
+
.\aicgen.exe stats
|
|
81
|
+
|
|
82
|
+
# Test init with dry-run
|
|
83
|
+
.\aicgen.exe init --dry-run
|
|
84
|
+
|
|
85
|
+
# Test full init (creates files)
|
|
86
|
+
.\aicgen.exe init
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### On Linux/macOS
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
# Make executable
|
|
93
|
+
chmod +x aicgen-linux
|
|
94
|
+
|
|
95
|
+
# Test
|
|
96
|
+
./aicgen-linux stats
|
|
97
|
+
./aicgen-linux init --dry-run
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Troubleshooting
|
|
101
|
+
|
|
102
|
+
### "bun: command not found"
|
|
103
|
+
|
|
104
|
+
Install Bun:
|
|
105
|
+
```bash
|
|
106
|
+
# Windows (PowerShell)
|
|
107
|
+
powershell -c "irm bun.sh/install.ps1 | iex"
|
|
108
|
+
|
|
109
|
+
# Linux/macOS
|
|
110
|
+
curl -fsSL https://bun.sh/install | bash
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### "Permission denied" on Linux/macOS
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
chmod +x aicgen-linux
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Build fails with "Cannot find module"
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
# Clean and reinstall
|
|
123
|
+
rm -rf node_modules
|
|
124
|
+
bun install
|
|
125
|
+
bun run build:binary
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Type errors
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# Check what's wrong
|
|
132
|
+
bun run typecheck
|
|
133
|
+
|
|
134
|
+
# Often fixed by:
|
|
135
|
+
bun install
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Development Build (No Binary)
|
|
139
|
+
|
|
140
|
+
For development without creating a binary:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
# Watch mode (auto-rebuild on changes)
|
|
144
|
+
bun run dev
|
|
145
|
+
|
|
146
|
+
# Run directly with Bun
|
|
147
|
+
bun run start init
|
|
148
|
+
bun run start stats
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## File Sizes
|
|
152
|
+
|
|
153
|
+
Expected binary sizes:
|
|
154
|
+
- Windows: ~45-50 MB
|
|
155
|
+
- Linux: ~45-50 MB
|
|
156
|
+
- macOS: ~45-50 MB
|
|
157
|
+
|
|
158
|
+
These are standalone executables with Bun runtime embedded.
|
|
159
|
+
|
|
160
|
+
## Distribution
|
|
161
|
+
|
|
162
|
+
After building, you can distribute the binary:
|
|
163
|
+
|
|
164
|
+
1. **Single file** - No dependencies needed
|
|
165
|
+
2. **Cross-platform** - Build on any OS for any OS
|
|
166
|
+
3. **Fast startup** - Bun's optimized runtime
|
|
167
|
+
|
|
168
|
+
Share the appropriate binary:
|
|
169
|
+
- `aicgen.exe` for Windows users
|
|
170
|
+
- `aicgen-linux` for Linux users
|
|
171
|
+
- `aicgen-macos` for macOS users
|
|
172
|
+
|
|
173
|
+
## Next Steps
|
|
174
|
+
|
|
175
|
+
After building successfully:
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
# Move to a directory in your PATH (optional)
|
|
179
|
+
# Windows: Copy to C:\Windows\System32 or add to PATH
|
|
180
|
+
# Linux/macOS:
|
|
181
|
+
sudo mv aicgen-linux /usr/local/bin/aicgen
|
|
182
|
+
|
|
183
|
+
# Test in any directory
|
|
184
|
+
cd ~/some-project
|
|
185
|
+
aicgen init
|
|
186
|
+
```
|