project-compass 3.6.2 → 3.6.4
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 +40 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
Project Compass is a high-performance, TUI (Terminal User Interface) workspace orchestrator built with Ink and React. It transforms your terminal into a command center for managing complex, multi-stack environments with a focus on speed, safety, and visual clarity.
|
|
6
6
|
|
|
7
|
+
## 🛠️ Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g project-compass
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 🔗 Links
|
|
14
|
+
- **NPM**: [npmjs.com/package/project-compass](https://www.npmjs.com/package/project-compass)
|
|
15
|
+
- **GitHub**: [github.com/CrimsonDevil333333/project-compass](https://github.com/CrimsonDevil333333/project-compass)
|
|
16
|
+
|
|
7
17
|
|
|
8
18
|
|
|
9
19
|
## 🌟 Premium Features
|
|
@@ -62,12 +72,39 @@ Project Compass is a high-performance, TUI (Terminal User Interface) workspace o
|
|
|
62
72
|
|
|
63
73
|
|
|
64
74
|
|
|
65
|
-
##
|
|
75
|
+
## ⚙️ Configuration & Customization
|
|
66
76
|
|
|
67
|
-
|
|
68
|
-
|
|
77
|
+
Project Compass is designed to be personalized. All settings and custom commands are stored in a local JSON file.
|
|
78
|
+
|
|
79
|
+
- **Location**: `~/.project-compass/config.json` (Automatically created on first run)
|
|
80
|
+
|
|
81
|
+
### 🛠️ Adding Custom Commands
|
|
82
|
+
You can add your own project-specific commands directly within the app by pressing **Shift+C** in the Detail View. Use the format `Label|Command` (e.g., `Deploy|npm run deploy`).
|
|
83
|
+
|
|
84
|
+
### 📁 Manual Config Structure
|
|
85
|
+
If you prefer manual editing, the `config.json` follows this structure:
|
|
86
|
+
|
|
87
|
+
```json
|
|
88
|
+
{
|
|
89
|
+
"showArtBoard": true,
|
|
90
|
+
"showHelpCards": false,
|
|
91
|
+
"showStructureGuide": false,
|
|
92
|
+
"customCommands": {
|
|
93
|
+
"/path/to/your/project": [
|
|
94
|
+
{
|
|
95
|
+
"label": "Build Production",
|
|
96
|
+
"command": ["npm", "run", "build", "--prod"]
|
|
97
|
+
}
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
}
|
|
69
101
|
```
|
|
70
102
|
|
|
103
|
+
- `showArtBoard/HelpCards/Structure`: Persistence for your UI visibility preferences.
|
|
104
|
+
- `customCommands`: A map of absolute project paths to arrays of command objects.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
71
108
|
## 🚀 Vision
|
|
72
109
|
Project Compass is designed to be the "Last Terminal Tool" you ever need to open. It bridges the gap between raw CLI commands and full IDEs, giving you a professional, reactive cockpit for all your development work.
|
|
73
110
|
|