@hyperflow.fun/ghost 0.0.1 → 0.0.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 CHANGED
@@ -13,30 +13,47 @@ AI companion for Hyperliquid perpetual contract traders. Not a dashboard. Not a
13
13
 
14
14
  ## Quick Start
15
15
 
16
- Ghost is in early access — install by cloning the repository:
16
+ Requires **[Bun](https://bun.sh) >= 1.1**:
17
17
 
18
18
  ```bash
19
- git clone https://github.com/hyperflowdotfun/ghost.git
20
- cd ghost
21
- bun install
22
- cd web && bun install && cd ..
23
- bun run dev onboard # Setup wizard (one-time)
24
- bun run dev # Build web + start gateway (port 15401)
19
+ # Install Bun (if you don't have it)
20
+ curl -fsSL https://bun.sh/install | bash # macOS / Linux
21
+ powershell -c "irm bun.sh/install.ps1 | iex" # Windows
25
22
  ```
26
23
 
27
- ### Commands
24
+ **1. Install Ghost**
28
25
 
29
26
  ```bash
30
- bun run dev daemon # Start Ghost
31
- bun run dev daemon --paper # Paper trading (simulated, 10k USDC)
32
- bun run dev daemon --paper -b 50000 # Paper mode with custom balance
33
- bun run dev status # Config summary
34
- bun run dev doctor # Full diagnostic
27
+ npm install -g @hyperflow.fun/ghost
35
28
  ```
36
29
 
37
- ### LLM Providers
30
+ **2. Onboard**
38
31
 
39
- OpenRouter, Anthropic (API), Claude Code, OpenAI, Google Gemini, or any custom OpenAI-compatible endpoint.
32
+ ```bash
33
+ ghost onboard
34
+ ```
35
+
36
+ You'll be asked to pick:
37
+
38
+ - **Trading Mode** — Paper (virtual funds, no wallet) or Live (real trades on Hyperliquid)
39
+ - **LLM Model** — Claude Code, Anthropic, OpenAI, Gemini, OpenRouter, or a custom endpoint
40
+ - **Install Ghost service** — Select **Yes** to keep Ghost running in the background
41
+
42
+ **3. Open the dashboard**
43
+
44
+ Visit **http://localhost:15401** and start trading.
45
+
46
+ ## Commands
47
+
48
+ ```bash
49
+ ghost daemon # Start Ghost in the foreground
50
+ ghost status # Show config and auth summary
51
+ ghost doctor # Full diagnostic
52
+ ghost update # Check for a new version and reinstall in place
53
+ ghost uninstall # Remove service + ~/.ghost
54
+ ```
55
+
56
+ See the [User Guide](USER_GUIDE.md) for the full reference.
40
57
 
41
58
  ## Documentation
42
59
 
@@ -50,29 +67,18 @@ OpenRouter, Anthropic (API), Claude Code, OpenAI, Google Gemini, or any custom O
50
67
  | [Personas](PERSONAS.md) | Trader personas and emotion-response framework |
51
68
  | [Journeys](JOURNEYS.md) | Journey narratives — Ghost in action for each persona |
52
69
 
53
- ## Tech Stack
54
-
55
- Bun + TypeScript, pi-agent-core + pi-ai, ElysiaJS, @nktkas/hyperliquid, grammY, React + Vite + Tailwind.
56
-
57
70
  ## Data Storage
58
71
 
59
- All data stored in `~/.ghost/` (config, credentials, database, memory, sessions).
60
-
61
- ## Uninstall
72
+ All data stored in `~/.ghost/` (config, credentials, database, memory, sessions). Nothing leaves your machine.
62
73
 
63
- Delete the repository and optionally your data:
64
-
65
- ```bash
66
- # macOS / Linux
67
- rm -rf ghost # Delete the clone
68
- rm -rf ~/.ghost # Delete all Ghost data (optional)
69
-
70
- # Windows (PowerShell)
71
- Remove-Item -Recurse -Force ghost # Delete the clone
72
- Remove-Item -Recurse -Force ~/.ghost # Delete all Ghost data (optional)
73
- ```
74
+ ## Notes
74
75
 
75
- See [User Guide](USER_GUIDE.md#uninstall) for details.
76
+ - Ghost does not yet support switching between Paper and Live mode. To switch, uninstall and reinstall.
77
+ - If you installed an earlier version, uninstall first — this release contains breaking changes:
78
+ ```bash
79
+ ghost uninstall
80
+ npm uninstall -g @hyperflow.fun/ghost
81
+ ```
76
82
 
77
83
  ## Security
78
84