Skip to content

Commit bd550ab

Browse files
committed
Add commands
1 parent d5af5b0 commit bd550ab

3 files changed

Lines changed: 247 additions & 0 deletions

File tree

‎assets/commands/chalie.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# TAGLINE
2+
3+
Local personal AI companion with persistent memory
4+
5+
# TLDR
6+
7+
**Install** with the official installer
8+
9+
```curl -fsSL https://chalie.ai/install | bash```
10+
11+
**Start** on the default port (31025)
12+
13+
```chalie```
14+
15+
**Start** on a custom port
16+
17+
```chalie --port=[9000]```
18+
19+
**Stop** the daemon
20+
21+
```chalie stop```
22+
23+
**Restart** the daemon
24+
25+
```chalie restart```
26+
27+
**Update** to the latest release
28+
29+
```chalie update```
30+
31+
**Check** whether it is running
32+
33+
```chalie status```
34+
35+
**Follow** the log file
36+
37+
```chalie logs```
38+
39+
# SYNOPSIS
40+
41+
**chalie** [**--port=**_N_] [**--host=**_H_] [_command_]
42+
43+
# DESCRIPTION
44+
45+
**chalie** is an open-source personal AI that runs on your machine. It keeps working in the background with persistent memory (episodes, concepts, and abstractions with decay), goal tracking, and proactive research. Actions go through an Allow / Ask / Deny policy so it does not act without consent.
46+
47+
It is a single Python process (Flask + WebSocket) with SQLite storage (including vector and FTS search). Optional local voice uses ONNX STT/TTS. Features include vision (photos/screenshots), a driven browser, MCP clients and tools, email/calendar/contacts (IMAP, CalDAV, CardDAV), a natural-language scheduler, guarded shell and sandboxed code, and encrypted whole-instance backup. Models can be cloud providers (OpenAI, Anthropic, Gemini) or local via **ollama**. Default web UI: **http://localhost:31025**.
48+
49+
# PARAMETERS
50+
51+
**start**
52+
53+
> Start the daemon in the background (default if no command is given). Writes PID to **~/.chalie/chalie.pid** and logs to **~/.chalie/chalie.log**.
54+
55+
**stop**
56+
57+
> Stop a running instance and remove the PID file.
58+
59+
**restart**
60+
61+
> Stop, then start again with the same port/host options.
62+
63+
**update**
64+
65+
> Stop, re-run the installer for the latest release, then start again.
66+
67+
**status**
68+
69+
> Print whether Chalie is running and its PID.
70+
71+
**logs**
72+
73+
> Follow **~/.chalie/chalie.log** when stdout is a terminal; otherwise print the last 50 lines.
74+
75+
**version**, **-V**, **--version**
76+
77+
> Print the installed version.
78+
79+
**--port=**_N_, **--port** _N_
80+
81+
> Listen port (default: **31025**).
82+
83+
**--host=**_H_, **--host** _H_
84+
85+
> Bind address (default: **0.0.0.0**). Use **127.0.0.1** to keep the UI local-only.
86+
87+
# CONFIGURATION
88+
89+
**~/.chalie/**
90+
91+
> Install home: virtualenv (**venv/**), app source (**app/**), PID and log files.
92+
93+
**~/.chalie/app/data/**
94+
95+
> Persistent instance data (SQLite and related state). Not overwritten by upgrades.
96+
97+
**CHALIE_HOME**
98+
99+
> Override the install home directory (default **$HOME/.chalie**).
100+
101+
**CHALIE_VENV**
102+
103+
> Path to the Python virtualenv used by **run.sh** (set by the installer CLI).
104+
105+
First boot opens an onboarding wizard to choose a model provider. Fully local setup: install **ollama** and pull a supported model, then point Chalie at it during setup.
106+
107+
# CAVEATS
108+
109+
Requires Python 3.11+. Beta software: sharp edges are expected. First start may download a large embedding model (~400 MB). Binding to **0.0.0.0** exposes the UI on the network — restrict with **--host=127.0.0.1** or a firewall if the machine is shared. Ensure **~/.local/bin** is on **PATH** so the **chalie** wrapper is found after install.
110+
111+
# HISTORY
112+
113+
**Chalie** is an open-source personal AI companion focused on long-running local agency and restrained action policies rather than single-session chat. It ships under the Apache 2.0 license.
114+
115+
# SEE ALSO
116+
117+
[ollama](/man/ollama)(1), [llm](/man/llm)(1), [aichat](/man/aichat)(1), [sgpt](/man/sgpt)(1)
118+
119+
# RESOURCES
120+
121+
```[Source code](https://github.com/chalie-ai/chalie)```
122+
123+
```[Homepage](https://chalie.ai)```
124+
125+
```[Documentation](https://chalie.ai/docs)```
126+
127+
<!-- verified: 2026-07-20 -->

‎assets/commands/index.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1111,6 +1111,7 @@ cgset.md
11111111
chafa.md
11121112
chage.md
11131113
chainctl.md
1114+
chalie.md
11141115
chalk-cli.md
11151116
chardet.md
11161117
charles.md
@@ -4653,6 +4654,7 @@ montage.md
46534654
moo.md
46544655
moon-buggy.md
46554656
moonshine-voice.md
4657+
moonshine.md
46564658
mopac.md
46574659
more.md
46584660
moreutils.md

‎assets/commands/moonshine.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# TAGLINE
2+
3+
Headless game streaming server for Moonlight clients
4+
5+
# TLDR
6+
7+
**Install** from the Arch User Repository
8+
9+
```yay -S moonshine```
10+
11+
**Enable** the user service (start now and on boot)
12+
13+
```sudo systemctl enable --now moonshine@$USER```
14+
15+
**Allow** the service to run when you are not logged in
16+
17+
```sudo loginctl enable-linger $USER```
18+
19+
**Run** the server directly with a config file (builds from source)
20+
21+
```moonshine [/path/to/config.toml]```
22+
23+
**Pair** a Moonlight client by submitting its PIN
24+
25+
```curl -X POST "http://localhost:47989/submit-pin" -d "uniqueid=0123456789ABCDEF&pin=[PIN]"```
26+
27+
# SYNOPSIS
28+
29+
**moonshine** _config.toml_
30+
31+
# DESCRIPTION
32+
33+
**moonshine** is a Linux-only headless streaming host compatible with [Moonlight](https://moonlight-stream.org/) clients. It streams games (or any application) from your PC to phones, tablets, and other devices, and sends keyboard, mouse, and controller input back to the host.
34+
35+
Unlike desktop-sharing hosts, each stream runs in its own isolated Wayland compositor session, separate from your local desktop. The host remains usable while streaming, and no physical monitor or HDMI dummy plug is required.
36+
37+
Video is hardware-encoded (H.264, H.265, and experimental AV1) via Vulkan on NVIDIA RTX, AMD RDNA2+, or Intel Arc GPUs. Audio uses low-latency Opus (stereo or 5.1/7.1). HDR (10-bit) is supported when the game and client allow it. Clients need Moonlight v6.0.0 or newer. systemd is required to launch and manage application processes.
38+
39+
# PARAMETERS
40+
41+
_config.toml_
42+
43+
> Path to the TOML configuration file. Created automatically with defaults if it does not exist. The AUR package defaults to **$XDG_CONFIG_HOME/moonshine/config.toml**.
44+
45+
**-V**, **--version**
46+
47+
> Print version and exit.
48+
49+
# CONFIGURATION
50+
51+
**$XDG_CONFIG_HOME/moonshine/config.toml** (typically **~/.config/moonshine/config.toml**)
52+
53+
> Main configuration. Define applications and optional scanners.
54+
55+
Example application entry:
56+
57+
```
58+
[[application]]
59+
title = "Steam"
60+
boxart = "/path/to/steam.png"
61+
command = ["/usr/bin/steam", "steam://open/bigpicture"]
62+
pre_command = [
63+
["/usr/bin/systemctl", "stop", "conflicting.service"],
64+
]
65+
post_command = [
66+
["/usr/bin/nvidia-smi", "pstate", "performance"],
67+
]
68+
```
69+
70+
Steam library scanner (auto-discovers installed games):
71+
72+
```
73+
[[application_scanner]]
74+
type = "steam"
75+
library = "$HOME/.local/share/Steam"
76+
command = ["/usr/bin/steam", "-bigpicture", "steam://rungameid/{game_id}"]
77+
```
78+
79+
Desktop scanner (from .desktop files):
80+
81+
```
82+
[[application_scanner]]
83+
type = "desktop"
84+
directories = [
85+
"$HOME/.local/share/applications",
86+
"/usr/share/applications",
87+
]
88+
include_terminal = false
89+
resolve_icons = true
90+
```
91+
92+
**MOONSHINE_LOG**
93+
94+
> Environment filter for tracing (default level: **error**). Passed to the Rust tracing EnvFilter.
95+
96+
First-time pairing: connect with Moonlight, then open **http://localhost:47989/pin** on the host (or use the curl example above) to submit the PIN.
97+
98+
# CAVEATS
99+
100+
Linux and systemd only. Requires a GPU with Vulkan video encoding. AV1 encoding is experimental and can grow frame sizes over time on some NVIDIA drivers; prefer H.264 or H.265 until fixed. Not safe on public networks: the GameStream protocol is not fully encrypted at the application layer — use a VPN (**tailscale**, **wg**/WireGuard) for remote access and never expose ports to the internet.
101+
102+
# HISTORY
103+
104+
**Moonshine** is a Rust reimplementation of a Moonlight-compatible host focused on isolated headless sessions on Linux. It builds on ideas from Sunshine (GameStream host API), Inputtino (input devices), and magic-mirror (Vulkan/Wayland compositor streaming).
105+
106+
# SEE ALSO
107+
108+
[systemctl](/man/systemctl)(1), [loginctl](/man/loginctl)(1), [steam](/man/steam)(1), [tailscale](/man/tailscale)(1), [wg](/man/wg)(8), [yay](/man/yay)(8)
109+
110+
# RESOURCES
111+
112+
```[Source code](https://github.com/hgaiser/moonshine)```
113+
114+
```[Homepage](https://github.com/hgaiser/moonshine)```
115+
116+
```[Documentation](https://github.com/hgaiser/moonshine#readme)```
117+
118+
<!-- verified: 2026-07-20 -->

0 commit comments

Comments
 (0)