You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-34Lines changed: 33 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# @astrical/cli
1
+
# @nexical/cli
2
2
3
-
The official Command Line Interface (CLI) for the Astrical framework.
3
+
The official Command Line Interface (CLI) for the Nexical framework.
4
4
5
-
This project serves as the primary entry point for managing Astrical projects, handling tasks such as project initialization, module management, and development workflows. It is designed to be **extensible**, **fast**, and **developer-friendly**, focusing on a clean architecture that allows for easy addition of new commands.
5
+
This project serves as the primary entry point for managing Nexical projects, handling tasks such as project initialization, module management, and development workflows. It is designed to be **extensible**, **fast**, and **developer-friendly**, focusing on a clean architecture that allows for easy addition of new commands.
6
6
7
7
## Table of Contents
8
8
@@ -22,8 +22,8 @@ This project serves as the primary entry point for managing Astrical projects, h
22
22
23
23
## Purpose
24
24
25
-
The Astrical CLI allows developers to:
26
-
1.**Initialize** new Astrical projects with best practices built-in.
25
+
The Nexical CLI allows developers to:
26
+
1.**Initialize** new Nexical projects with best practices built-in.
27
27
2.**Manage** project configuration and dependencies.
28
28
3.**Extend** the framework functionality through modular commands.
29
29
@@ -36,7 +36,7 @@ This CLI is built with **TypeScript** and follows a **Class-Based Command Patter
36
36
### Key Technologies
37
37
***[CAC (Command And Conquer)](https://github.com/cacjs/cac)**: A lightweight, robust framework for building CLIs. It handles argument parsing, help generation, and command registration.
38
38
***[Consola](https://github.com/unjs/consola)**: Elegant console logging with fallback and structured output capabilities.
39
-
***[Lilconfig](https://github.com/antonk52/lilconfig)**: Configuration loading (searching for `astrical.yml`, `astrical.yaml`) akin to `cosmiconfig` but lighter.
39
+
***[Lilconfig](https://github.com/antonk52/lilconfig)**: Configuration loading (searching for `nexical.yml`, `nexical.yaml`) akin to `cosmiconfig` but lighter.
40
40
***Vitest**: A blazing fast unit test framework powered by Vite.
41
41
42
42
### Core Components
@@ -52,7 +52,7 @@ This CLI is built with **TypeScript** and follows a **Class-Based Command Patter
52
52
* Project root detection (`this.projectRoot`).
53
53
54
54
### Design Goals
55
-
***Zero-Config Defaults**: It should work out of the box but allow rich configuration via `astrical.yml`.
55
+
***Zero-Config Defaults**: It should work out of the box but allow rich configuration via `nexical.yaml`.
56
56
***Extensibility**: Adding a command should be as simple as adding a file.
57
57
***Testability**: Every component is designed to be unit-testable, with dependency injection where appropriate (e.g., `CommandLoader` importer).
58
58
@@ -74,37 +74,37 @@ npm run build
74
74
75
75
```bash
76
76
# Run the built CLI
77
-
npx astrical<command> [options]
77
+
npx nexical<command> [options]
78
78
79
79
# Example: Initialize a new project
80
-
npx astrical init my-new-project
80
+
npx nexical init my-new-project
81
81
82
82
# Get help
83
-
npx astricalhelp
83
+
npx nexicalhelp
84
84
85
85
# Get help for a specific command
86
-
npx astricalhelp init
87
-
npx astricalhelp module add
86
+
npx nexicalhelp init
87
+
npx nexicalhelp module add
88
88
```
89
89
90
90
### Command Reference
91
91
92
92
#### `init`
93
93
94
-
Initializes a new Astrical project by cloning a starter repository, setting up dependencies, and preparing a fresh git history.
94
+
Initializes a new Nexical project by cloning a starter repository, setting up dependencies, and preparing a fresh git history.
95
95
96
96
**Usage:**
97
97
```bash
98
-
npx astrical init <directory> [options]
98
+
npx nexical init <directory> [options]
99
99
```
100
100
101
101
**Arguments:**
102
102
-`directory` (Required): The directory to initialize the project in. If the directory does not exist, it will be created. If it does exist, it must be empty.
103
103
104
104
**Options:**
105
-
-`--repo <url>` (Default: `https://github.com/nexical/astrical-starter`): The URL of the starter repository to clone.
105
+
-`--repo <url>` (Default: `https://github.com/nexical/app-core`): The URL of the starter repository to clone.
106
106
- Supports standard Git URLs (e.g., `https://github.com/user/repo.git`).
107
-
- Supports GitHub short syntax `gh@owner/repo` (e.g., `gh@nexical/astrical-starter`).
107
+
- Supports GitHub short syntax `gh@owner/repo` (e.g., `gh@nexical/app-core`).
108
108
109
109
**What it does:**
110
110
1.**Clones** the specified starter repository (recursively, including submodules) into the target directory.
0 commit comments