project-compass 3.5.1 → 3.5.2
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 +28 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,17 @@
|
|
|
1
|
-
# Project Compass (
|
|
1
|
+
# Project Compass (v3.5.1)
|
|
2
2
|
|
|
3
|
-
Project Compass is a futuristic CLI navigator built with [Ink](https://github.com/vadimdemedes/ink)
|
|
3
|
+
Project Compass is a futuristic CLI navigator and lifecycle orchestrator built with [Ink](https://github.com/vadimdemedes/ink). It scans your folder tree for code projects and provides a unified interface to install, build, test, and manage them.
|
|
4
4
|
|
|
5
5
|
## Highlights
|
|
6
6
|
|
|
7
|
-
- 🔍
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
- 📂 **Log Management**: Clear output with **Shift+X** or export logs to a text file with **Shift+E**.
|
|
16
|
-
- 🔌 **Extensible**: Add custom commands with **Shift+C** and frameworks via `plugins.json`.
|
|
17
|
-
- 💾 **Persistence**: Saves your UI preferences (Art Board, Help, Structure Guide) globally in `~/.project-compass/config.json`.
|
|
7
|
+
- 🔍 **Omni-Scanner**: Deep-scans directories for Node.js, Python, Rust, Go, Java, Scala, PHP, Ruby, and .NET projects.
|
|
8
|
+
- 🏗️ **Project Architect (Shift+N)**: Scaffold new projects from industry-standard templates (Next.js, Vite, Rust, Go) into any target path.
|
|
9
|
+
- 📦 **Package Registry (Shift+P)**: Interactively add/remove dependencies and manage environments (like Python `.venv`) without leaving the CLI.
|
|
10
|
+
- 🛰️ **Orbit Task Manager (Shift+T)**: Run multiple commands in parallel, detach them to the background (**Shift+D**), and manage them (Rename/Kill).
|
|
11
|
+
- 💀 **Atomic Kill (Ctrl+C)**: Forcefully wipe out entire process trees and zombie servers using kernel-level signal forwarding.
|
|
12
|
+
- 💎 **Omni-Studio (Shift+A)**: Real-time environment intelligence dashboard showing all installed runtimes and versions.
|
|
13
|
+
- 💾 **Global Persistence**: Remembers your UI preferences (Art Board, Help, Structure Guide) via `~/.project-compass/config.json`.
|
|
14
|
+
- 🎨 **Flicker-Free UI**: Isolated rendering architecture ensures zero UI jitter even during high-velocity log streaming.
|
|
18
15
|
|
|
19
16
|
## Installation
|
|
20
17
|
|
|
@@ -28,41 +25,33 @@ npm install -g project-compass
|
|
|
28
25
|
project-compass [--dir /path/to/workspace] [--studio] [--version]
|
|
29
26
|
```
|
|
30
27
|
|
|
31
|
-
### Keyboard Guide
|
|
28
|
+
### Keyboard Master Guide
|
|
32
29
|
|
|
33
30
|
| Key | Action |
|
|
34
31
|
| --- | --- |
|
|
35
|
-
| ↑ / ↓ | Move focus
|
|
36
|
-
|
|
|
37
|
-
|
|
|
32
|
+
| ↑ / ↓ | Move focus between projects |
|
|
33
|
+
| **Enter** | Toggle Detail View / Return from Tasks |
|
|
34
|
+
| **Shift+N** | Open **Project Architect** (Create new project) |
|
|
35
|
+
| **Shift+P** | Open **Package Registry** (Manage dependencies) |
|
|
38
36
|
| **Shift+T** | Open **Orbit Task Manager** |
|
|
39
|
-
| **Shift+D** | **Detach**
|
|
40
|
-
| **Shift+A** | Open **Omni-Studio** (Environment
|
|
37
|
+
| **Shift+D** | **Detach** active task to background |
|
|
38
|
+
| **Shift+A** | Open **Omni-Studio** (Environment intelligence) |
|
|
41
39
|
| **Shift+B** | Toggle **Art Board** visibility |
|
|
42
40
|
| **Shift+H** | Toggle **Help Cards** visibility |
|
|
43
|
-
| **Shift+S** | Toggle **Structure Guide**
|
|
44
|
-
| **Shift+
|
|
45
|
-
| **Shift+
|
|
46
|
-
| **Shift+
|
|
47
|
-
| **Shift
|
|
48
|
-
| **
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
| Shift+Q | Quit app (with confirmation if tasks run) |
|
|
52
|
-
| **Ctrl+C** | Force quit and kill all background tasks |
|
|
41
|
+
| **Shift+S** | Toggle **Structure Guide** |
|
|
42
|
+
| **Shift+X** | **Clear** log buffer for active task |
|
|
43
|
+
| **Shift+E** | **Export** current logs to `.txt` |
|
|
44
|
+
| **Shift+L** | **Rerun** last executed command |
|
|
45
|
+
| **Shift+Q** | **Quit** (Confirms if tasks are running) |
|
|
46
|
+
| **Ctrl+C** | **Force Kill** all background tasks and exit |
|
|
47
|
+
| Shift+↑ / ↓ | Scroll output logs (Intuitive direction) |
|
|
48
|
+
| **?** | Toggle help overlay |
|
|
53
49
|
|
|
54
|
-
##
|
|
50
|
+
## Framework Support
|
|
55
51
|
|
|
56
|
-
|
|
52
|
+
Compass provides specialized intelligence for 20+ stacks including **Next.js, React, Vue, NestJS, Spring Boot, ASP.NET Core, Laravel, Rocket, Actix, Prisma, and Tailwind**.
|
|
57
53
|
|
|
58
|
-
|
|
59
|
-
- **Shift+K**: Kill a running process or remove a task from history.
|
|
60
|
-
- **Shift+R**: Rename a task for better organization.
|
|
61
|
-
- **Enter**: Switch back to the Navigator with the selected task's logs.
|
|
62
|
-
|
|
63
|
-
## Omni-Studio
|
|
64
|
-
|
|
65
|
-
Launch with `project-compass --studio` or press **Shift+A** inside the app. Omni-Studio provides real-time intelligence on your installed development environments, checking versions for Node, Python, Rust, Go, Java, and more.
|
|
54
|
+
For a full list of framework-specific commands and shortcuts, see [commands.md](./commands.md).
|
|
66
55
|
|
|
67
56
|
## License
|
|
68
57
|
|