project-compass 4.1.6 → 4.1.8

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.
Files changed (4) hide show
  1. package/README.md +26 -13
  2. package/commands.md +9 -3
  3. package/package.json +1 -1
  4. package/src/cli.js +11 -0
package/README.md CHANGED
@@ -14,14 +14,29 @@ npm install -g project-compass
14
14
  - **NPM**: [npmjs.com/package/project-compass](https://www.npmjs.com/package/project-compass)
15
15
  - **GitHub**: [github.com/CrimsonDevil333333/project-compass](https://github.com/CrimsonDevil333333/project-compass)
16
16
 
17
+ ## 🌌 The Navigator
17
18
  ![Navigator View](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/navigator.jpg)
18
19
 
19
- ## 🌟 Premium Features
20
+ ### 🌟 Premium Features
20
21
 
21
22
  ### 🌌 The Navigator (Main Interface)
22
23
  - **Automatic Discovery**: Instantly identifies **Node.js, Python, Rust, Go, Java, PHP, Ruby, .NET, and Shell/Make**.
23
- - **Paginated Control**: Optimized for massive workspaces. Jump through project pages with **Page Up / Page Down**.
24
- - **Configurable UI**: Customize your view with `maxVisibleProjects` (set to 2 or 3 for tight terminals).
24
+ - **Paginated Control**: Optimized for massive workspaces. View projects in clean, manageable pages with **Page Up / Page Down** support.
25
+ - **Configurable UI**: Customize your view with `maxVisibleProjects` and toggleable Art Boards and Help Cards.
26
+
27
+ ### 🛰️ Orbit Task Manager (`Shift+T`)
28
+ ![Task Manager](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/taskmanager.jpg)
29
+ - **Background Orchestration**: Keep tasks running while you navigate.
30
+ - **Process Management**: Kill (`Shift+K`) or Rename (`Shift+R`) background tasks on the fly.
31
+
32
+ ### 📦 Package Registry (`Shift+P`)
33
+ ![Package Registry](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/registry.jpg)
34
+ - **Native Logic**: Automatically uses your project's preferred package manager (**npm, pnpm, yarn, bun, pip, cargo, composer, dotnet**).
35
+ - **Internal Switcher**: Quick-swap between detected projects directly inside the registry.
36
+
37
+ ### 🏗️ Project Architect (`Shift+N`)
38
+ ![Project Architect](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/architect.jpg)
39
+ - **Modern Templates**: Scaffold high-performance projects with built-in support for **Bun, Next.js, Vite, Rust, and Django**.
25
40
 
26
41
  ### 🤖 AI Horizon (`Shift+O` or `0`)
27
42
  - **Agentic Intelligence**: Real-world integration with **OpenRouter, Gemini, Claude, and Ollama**.
@@ -32,15 +47,9 @@ npm install -g project-compass
32
47
  - **Manual Port Mapping**: Directly assign specific ports to projects. Config is saved persistently to prevent conflicts.
33
48
  - **Metadata Awareness**: AI Horizon uses your manual port settings to suggest smarter deployment scripts.
34
49
 
35
- ### 🛰️ Orbit Task Manager (`Shift+T`)
36
- - **Background Orchestration**: Keep tasks running while you navigate.
37
- - **Process Management**: Kill (`Shift+K`) or Rename (`Shift+R`) background tasks on the fly.
38
-
39
- ### 📦 Package Registry (`Shift+P`)
40
- - **Context-Aware Management**: Automatically detects **npm, pnpm, yarn, bun, pip, cargo, composer, and dotnet**.
41
-
42
- ### 🏗️ Project Architect (`Shift+N`)
43
- - **Rapid Scaffolding**: Create new projects from scratch using industry-standard templates.
50
+ ### 🎨 Omni-Studio & Art Board
51
+ ![Omni-Studio](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/studio.jpg)
52
+ ![Art Board](https://raw.githubusercontent.com/CrimsonDevil333333/project-compass/master/assets/screenshots/artboard.jpg)
44
53
 
45
54
  ## ⌨️ Command Reference
46
55
 
@@ -55,12 +64,16 @@ npm install -g project-compass
55
64
  | `Shift + O` | **AI Horizon** Dashboard |
56
65
  | `Shift + T` | **Orbit**: Task Manager |
57
66
  | `Shift + P` | **Registry**: Package Manager |
67
+ | `Shift + A` | **Studio**: Environment Health |
68
+ | `Shift + B` | Toggle **Art Board** visibility |
69
+ | `Shift + H` | Toggle **Help Cards** |
70
+ | `Shift + S` | Toggle **Structure Guide** |
58
71
  | `Shift + Q` | **Quit** (with terminal clear) |
59
72
 
60
73
  ## ⚙️ Configuration
61
74
 
62
75
  Edit `~/.project-compass/config.json` to customize:
63
- - `maxVisibleProjects`: How many rows per page.
76
+ - `maxVisibleProjects`: How many rows per page (default: 3).
64
77
  - `aiToken / aiModel`: Your intelligence credentials.
65
78
 
66
79
  ---
package/commands.md CHANGED
@@ -2,12 +2,17 @@
2
2
 
3
3
  This document lists all supported languages, frameworks, and their built-in commands and keyboard shortcuts.
4
4
 
5
- ## Keyboard Guide (Navigator)\n\n| Key | Action |\n| --- | --- |\n| **Shift+O** | Open **AI Horizon** (Workspace Intelligence) |
5
+ ## Keyboard Guide (Navigator)
6
+
7
+ | Key | Action |
8
+ | --- | --- |
9
+ | **Shift+O** | Open **AI Horizon** (Workspace Intelligence) |
6
10
 
7
11
  | Key | Action |
8
12
  | --- | --- |
9
13
  | ↑ / ↓ | Move project focus |
10
- | Enter | Toggle deep detail view / Switch back from sub-views |\n| **0** | **Quick AI Analysis** (Detail View only) |
14
+ | Enter | Toggle deep detail view / Switch back from sub-views |
15
+ | **0** | **Quick AI Analysis** (Detail View only) |
11
16
  | **B / T / R / I**| **Macro Launch**: Build, Test, Run, **Install** |
12
17
  | **Esc** | **Global Back**: Return to Main Navigator from any view |
13
18
  | **Shift+A** | Open **Omni-Studio** (Environment & Runtime audit) |
@@ -20,7 +25,8 @@ This document lists all supported languages, frameworks, and their built-in comm
20
25
  | **Shift+S** | Toggle **Structure Guide** (Saved to config) |
21
26
  | **Shift+X** | **Clear** active task output logs |
22
27
  | **Shift+E** | **Export** logs to a timestamped `.txt` file |
23
- | **Shift+L** | **Rerun** the last executed command |\n| PgUp / PgDn | Jump full project page |
28
+ | **Shift+L** | **Rerun** the last executed command |
29
+ | PgUp / PgDn | Jump full project page |
24
30
  | **Shift+C** | Add a **Custom Command** (`label|cmd`) in detail view |
25
31
  | **Shift+Q** | **Quit** application (Confirms if tasks are running) |
26
32
  | Shift+↑ / ↓ | Scroll output logs |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "project-compass",
3
- "version": "4.1.6",
3
+ "version": "4.1.8",
4
4
  "description": "Futuristic project navigator and runner for Node, Python, Rust, and Go",
5
5
  "main": "src/cli.js",
6
6
  "bin": {
package/src/cli.js CHANGED
@@ -294,6 +294,17 @@ function Compass({rootPath, initialView = 'navigator'}) {
294
294
  }, [tasks, activeTaskId, addLogToTask]);
295
295
 
296
296
  useInput((input, key) => {
297
+
298
+ if (key.shift && (input === 'R' || input === 'r')) {
299
+ if (viewMode === 'detail' && selectedProject) {
300
+ setPortConfigMode(true);
301
+ const currentPort = config.projectMeta?.[selectedProject.path]?.port || '3000';
302
+ setCustomInput(String(currentPort));
303
+ setCustomCursor(String(currentPort).length);
304
+ return;
305
+ }
306
+ }
307
+
297
308
  if (quitConfirm) {
298
309
  if (input?.toLowerCase() === 'y') { killAllTasks(); process.stdout.write('\x1b[2J\x1b[0;0H'); exit(); return; }
299
310
  if (input?.toLowerCase() === 'n' || key.escape) { setQuitConfirm(false); return; }