63 行
2.1 KiB
Markdown
63 行
2.1 KiB
Markdown
|
|
# AstrBot Desktop
|
||
|
|
|
||
|
|
AstrBot Desktop is a Windows companion and local-assistance client built with Tauri 2, React, TypeScript, Vite, and Rust.
|
||
|
|
|
||
|
|
The MVP supports two isolated active AstrBot connection slots:
|
||
|
|
|
||
|
|
- `companion` for chat, proactive messages, voice, and game companionship;
|
||
|
|
- `operations` for user-authorized, policy-controlled diagnostics and recoverable file operations.
|
||
|
|
|
||
|
|
## Security boundaries
|
||
|
|
|
||
|
|
- Credentials remain in Windows secure storage and are never exposed to React.
|
||
|
|
- Server tool requests are proposals; the Rust policy layer makes the final decision.
|
||
|
|
- The application does not provide arbitrary PowerShell, CMD, or shell execution.
|
||
|
|
- NAS transfers use `plan -> dry run -> copy -> verify -> commit` and preserve source files on failure.
|
||
|
|
|
||
|
|
## Current phase
|
||
|
|
|
||
|
|
The repository is in the P00 bootstrap and high-risk Spike phase. See [docs/implementation-plan.md](docs/implementation-plan.md) and [docs/progress.md](docs/progress.md).
|
||
|
|
|
||
|
|
## Authoritative documents
|
||
|
|
|
||
|
|
- `AGENTS.md`
|
||
|
|
- `docs/01_Architecture_Design.md`
|
||
|
|
- `docs/02_Codex_Implementation_Tasks.md`
|
||
|
|
- `AstrBot_Desktop_Codex_Forgejo_Predevelopment_Workflow.md`
|
||
|
|
|
||
|
|
## Development prerequisites
|
||
|
|
|
||
|
|
- Windows 11
|
||
|
|
- Node.js and pnpm
|
||
|
|
- Rust stable with the MSVC target
|
||
|
|
- Visual Studio 2022 Build Tools with Desktop development with C++
|
||
|
|
- WebView2 Evergreen Runtime
|
||
|
|
|
||
|
|
## Local commands
|
||
|
|
|
||
|
|
```text
|
||
|
|
pnpm install --frozen-lockfile
|
||
|
|
pnpm check:frontend
|
||
|
|
pnpm test:e2e
|
||
|
|
pnpm rust:fmt
|
||
|
|
pnpm rust:clippy
|
||
|
|
pnpm rust:test
|
||
|
|
pnpm rust:check
|
||
|
|
pnpm tauri:dev
|
||
|
|
pnpm tauri:build
|
||
|
|
```
|
||
|
|
|
||
|
|
On Windows, Cargo build output can be redirected away from a NAS workspace:
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
$env:CARGO_TARGET_DIR = "$env:LOCALAPPDATA\Temp\AstrBot-Desktop-target"
|
||
|
|
```
|
||
|
|
|
||
|
|
The 30-minute connection soak and the controlled Windows UIA/capture smoke are
|
||
|
|
ignored by the normal suite and must be invoked explicitly as documented in
|
||
|
|
[tests/README.md](tests/README.md). The UIA/capture smoke opens only a generated,
|
||
|
|
non-sensitive standard dialog and never writes captured pixels to disk.
|
||
|
|
|
||
|
|
P00 results and unresolved environment boundaries are recorded in
|
||
|
|
[docs/spikes](docs/spikes) and [docs/progress.md](docs/progress.md).
|