CLI Quick Start
CLI Quick Start
End-to-end quick start tutorial: install the CLI, initialize workspace, run diagnostic checks, launch a server, ping, and transfer files.
This workflow guides you from a fresh terminal right to establishing an encrypted KSP multiplexed session and transferring your first file in under 60 seconds.
1. Install CLI
2. ksp init
3. ksp doctor
4. ksp server start
5. ksp ping & transfer
Step 1 & 2
Install & Initialize Workspace
Open your terminal, install the binary, and initialize a new KSP configuration profile in a project directory:
# Install KSP CLI on Windows or Linux irm https://install.kspprotocol.dev | iex # Create a workspace directory and initialize configuration mkdir ksp-demo && cd ksp-demo ksp init --profile high-security
Step 3
Run System Health Diagnostics
Ensure your raw UDP/TCP socket permissions and hardware AES-NI cryptographic acceleration are operational:
ksp doctor # Output: # [✔] OS Platform: Windows 11 x86_64 / Linux x86_64 # [✔] Crypto Backend: Hardware AES-NI & AVX2 Acceleration Enabled # [✔] Configuration: ksp.toml (Valid)
Step 4 & 5
Start Server & Test Connection
In one terminal tab, start the server. In a second tab, measure round-trip encrypted latency using ksp ping:
# Terminal 1 — Launch server ksp server start --port 9876 # Terminal 2 — Send encrypted ping frames ksp ping 127.0.0.1:9876 -c 4
Step 6 & 7
Transfer Data & Monitor Metrics
Transfer a local file over a multiplexed stream and inspect real-time throughput metrics via the dashboard:
# Transmit file with on-the-fly LZ4 compression over KSP Stream ID 3 ksp transfer ./ksp.toml --to 127.0.0.1:9876 --compress # Launch live TUI dashboard to observe stream bandwidth ksp dashboard --theme cyberpunk