AeThex-OS/aethex-docs/packages/cli/README.md
MrPiglr a15b5b1015 feat: integrate AeThex Language across entire OS ecosystem
Major Features:
- Custom .aethex programming language with cross-platform compilation
- Compiles to JavaScript, Lua (Roblox), Verse (UEFN), and C# (Unity)
- Built-in COPPA compliance and PII detection for safe metaverse development

Integration Points:
1. Terminal Integration
   - Added 'aethex' command for in-terminal compilation
   - Support for all compilation targets with --target flag
   - Real-time error reporting and syntax highlighting

2. IDE Integration
   - Native .aethex file support in Monaco editor
   - One-click compilation with target selector
   - Download compiled code functionality
   - Two example files: hello.aethex and auth.aethex

3. Curriculum Integration
   - New "AeThex Language" section in Foundry tech tree
   - Three modules: Realities & Journeys, Cross-Platform Sync, COPPA Compliance
   - Certification path for students

4. Documentation Site
   - Complete docs at /docs route (client/src/pages/aethex-docs.tsx)
   - Searchable documentation with sidebar navigation
   - Language guide, standard library reference, and examples
   - Ready for deployment to aethex.dev

5. npm Package Publishing
   - @aethex.os/core@1.0.0 - Standard library (published)
   - @aethex.os/cli@1.0.1 - Command line compiler (published)
   - Both packages live on npm and globally installable

Domain Configuration:
- DNS setup for 29+ domains (aethex.app, aethex.co, etc.)
- nginx reverse proxy configuration
- CORS configuration for cross-domain requests
- OAuth redirect fixes for hash-based routing

Standard Library Features:
- Passport: Universal identity across platforms
- DataSync: Cross-platform data synchronization
- SafeInput: PII detection (phone, email, SSN, credit cards)
- Compliance: COPPA/FERPA age gates and audit logging

Documentation Package:
- Created aethex-dev-docs.zip with complete documentation
- Ready for static site deployment
- Includes examples, API reference, and quickstart guide

Technical Improvements:
- Fixed OAuth blank page issue (hash routing)
- Added .gitignore rules for temp files
- Cleaned up build artifacts and temporary files
- Updated all package references to @aethex.os namespace

Co-Authored-By: Claude <noreply@anthropic.com>
2026-02-11 22:28:05 -07:00

129 lines
2.3 KiB
Markdown

# @aethex.os/cli
AeThex Language Command Line Interface - Compile `.aethex` files to JavaScript, Lua, Verse, and C#.
## Installation
```bash
npm install -g @aethex.os/cli
```
## Usage
### Compile a file
```bash
aethex compile myfile.aethex
```
### Compile to specific target
```bash
# JavaScript (default)
aethex compile myfile.aethex --target javascript
# Roblox/Lua
aethex compile myfile.aethex --target roblox
# UEFN/Verse (coming soon)
aethex compile myfile.aethex --target uefn
# Unity/C# (coming soon)
aethex compile myfile.aethex --target unity
```
### Save to file
```bash
aethex compile myfile.aethex -o output.js
aethex compile myfile.aethex -t roblox -o game.lua
```
### Watch mode
```bash
aethex compile myfile.aethex --watch
```
### Create new project
```bash
# Basic project
aethex new my-project
# With template
aethex new my-game --template passport
```
### Initialize in existing directory
```bash
aethex init
```
## Example
Create `hello.aethex`:
```aethex
reality HelloWorld {
platforms: all
}
journey Greet(name) {
platform: all
notify "Hello, " + name + "!"
}
```
Compile it:
```bash
aethex compile hello.aethex -o hello.js
```
Run it:
```bash
node hello.js
```
## Commands
- `aethex compile <file>` - Compile an AeThex file
- `aethex new <name>` - Create new project
- `aethex init` - Initialize in current directory
- `aethex --help` - Show help
- `aethex --version` - Show version
## Options
- `-t, --target <platform>` - Target platform (javascript, roblox, uefn, unity)
- `-o, --output <file>` - Output file path
- `-w, --watch` - Watch for changes
- `--template <type>` - Project template (basic, passport, game)
## Targets
| Target | Language | Platform | Status |
|--------|----------|----------|--------|
| `javascript` | JavaScript | Web, Node.js | ✅ Ready |
| `roblox` | Lua | Roblox | ✅ Ready |
| `uefn` | Verse | Fortnite | 🚧 Coming Soon |
| `unity` | C# | Unity, VRChat | 🚧 Coming Soon |
## Learn More
- [Language Guide](https://aethex.dev/lang)
- [Examples](https://github.com/aethex/aethex-lang/tree/main/examples)
- [Standard Library (@aethex.os/core)](https://www.npmjs.com/package/@aethex.os/core)
## License
MIT © AeThex Foundation
## Links
- [Documentation](https://aethex.dev/lang)
- [GitHub](https://github.com/aethex/aethex-lang)
- [Issues](https://github.com/aethex/aethex-lang/issues)