Quick Start

Let's run your first whisp command.

Start the Daemon

First, start the whisp daemon:

whisp start
# Daemon started successfully

The daemon runs in the background and handles all AI requests.

Your First Command

Use the comma prefix to ask whisp for a command:

, find all files larger than 100mb

Whisp will respond with the command and an explanation:

Command: find . -type f -size +100M

Finds all files larger than 100 megabytes in the current directory
and subdirectories.

Run this command? [Y/n]

Press Enter to run it, or n to cancel.

More Examples

Try these to get a feel for whisp:

# File operations
, compress all png files in this folder
# → tar -czvf images.tar.gz *.png

# System info
, show disk usage by folder sorted by size
# → du -h --max-depth=1 | sort -hr

# Docker commands
, list running containers with their memory usage
# → docker stats --no-stream

# Git operations
, show commits from last week by author
# → git log --since="1 week ago" --format="%h %an: %s"

# Process management
, find the process using port 3000
# → lsof -i :3000

Shell Shortcuts

Whisp provides shortcuts for common operations:

Shortcut	Action	Example
`,`	Generate command	`, find large files`
`,!`	Run last command	`,!`
`,.`	Explain command	`,. tar -xzf file.tar.gz`
`,d`	Dry-run preview	`,d rm -rf ./build`
`,,`	Show alternatives	`,,`
`,/`	Search history	`,/ docker`

Explain a Command

Not sure what a command does? Use ,.:

,. tar -czvf archive.tar.gz ./docs

Output:

Explanation: Creates a compressed tar archive of the docs directory.

Breakdown:
- tar: Archive utility
- -c: Create new archive
- -z: Compress with gzip
- -v: Verbose output
- -f: Specify filename

Preview Before Running

Use ,d to see what a command will do:

,d rm -rf ./node_modules

Output:

Reversible: No

Effects:
- Deletes directory ./node_modules recursively
- Removes approximately 15,234 files
- Frees ~450MB of disk space

Warning: This operation cannot be undone

Pipe Mode

Pipe command output to whisp for analysis:

cat error.log | , summarize the errors

Output:

Summary of errors:
- 3 connection timeout errors (10:15, 10:32, 11:45)
- 2 authentication failures from IP 192.168.1.50
- 1 disk space warning at 11:00

More pipe examples:

# Analyze code
cat script.py | , find potential bugs

# Process data
cat data.json | , extract all email addresses

# Understand configs
cat nginx.conf | , explain this config

Error Recovery

When a command fails, whisp can suggest fixes:

$ gcc main.c -o main
main.c: undefined reference to 'sqrt'

# Whisp automatically detects the error and suggests:
Fix: gcc main.c -o main -lm

The -lm flag links the math library which provides sqrt().

Run this fix? [Y/n]

Interactive Chat

For complex questions that need back-and-forth, use chat mode:

whisp chat

whisp> How do I set up a Python virtual environment?

Creating a virtual environment:
1. Create: python -m venv myenv
2. Activate: source myenv/bin/activate
3. Install packages: pip install <package>

whisp> What about with poetry?

Using Poetry:
1. Install: curl -sSL https://install.python-poetry.org | python3 -
2. Create project: poetry new myproject
3. Add packages: poetry add requests
...

whisp> exit

Check Your Setup

If something isn't working:

# Check daemon status
whisp status

# Run diagnostics
whisp doctor

# View health metrics
whisp health

Next Steps

Shell Shortcuts — Master all shortcuts
Interactive Chat — Multi-turn conversations
Providers & Models — Switch AI providers
Configuration — Customize behavior

Quick Start

Let's run your first whisp command.

Start the Daemon

First, start the whisp daemon:

whisp start
# Daemon started successfully

The daemon runs in the background and handles all AI requests.

Your First Command

Use the comma prefix to ask whisp for a command:

, find all files larger than 100mb

Whisp will respond with the command and an explanation:

Command: find . -type f -size +100M

Finds all files larger than 100 megabytes in the current directory
and subdirectories.

Run this command? [Y/n]

Press Enter to run it, or n to cancel.

More Examples

Try these to get a feel for whisp:

# File operations
, compress all png files in this folder
# → tar -czvf images.tar.gz *.png

# System info
, show disk usage by folder sorted by size
# → du -h --max-depth=1 | sort -hr

# Docker commands
, list running containers with their memory usage
# → docker stats --no-stream

# Git operations
, show commits from last week by author
# → git log --since="1 week ago" --format="%h %an: %s"

# Process management
, find the process using port 3000
# → lsof -i :3000

Shell Shortcuts

Whisp provides shortcuts for common operations:

Shortcut	Action	Example
`,`	Generate command	`, find large files`
`,!`	Run last command	`,!`
`,.`	Explain command	`,. tar -xzf file.tar.gz`
`,d`	Dry-run preview	`,d rm -rf ./build`
`,,`	Show alternatives	`,,`
`,/`	Search history	`,/ docker`

Explain a Command

Not sure what a command does? Use ,.:

,. tar -czvf archive.tar.gz ./docs

Output:

Explanation: Creates a compressed tar archive of the docs directory.

Breakdown:
- tar: Archive utility
- -c: Create new archive
- -z: Compress with gzip
- -v: Verbose output
- -f: Specify filename

Preview Before Running

Use ,d to see what a command will do:

,d rm -rf ./node_modules

Output:

Reversible: No

Effects:
- Deletes directory ./node_modules recursively
- Removes approximately 15,234 files
- Frees ~450MB of disk space

Warning: This operation cannot be undone

Pipe Mode

Pipe command output to whisp for analysis:

cat error.log | , summarize the errors

Output:

Summary of errors:
- 3 connection timeout errors (10:15, 10:32, 11:45)
- 2 authentication failures from IP 192.168.1.50
- 1 disk space warning at 11:00

More pipe examples:

# Analyze code
cat script.py | , find potential bugs

# Process data
cat data.json | , extract all email addresses

# Understand configs
cat nginx.conf | , explain this config

Error Recovery

When a command fails, whisp can suggest fixes:

$ gcc main.c -o main
main.c: undefined reference to 'sqrt'

# Whisp automatically detects the error and suggests:
Fix: gcc main.c -o main -lm

The -lm flag links the math library which provides sqrt().

Run this fix? [Y/n]

Interactive Chat

For complex questions that need back-and-forth, use chat mode:

whisp chat

whisp> How do I set up a Python virtual environment?

Creating a virtual environment:
1. Create: python -m venv myenv
2. Activate: source myenv/bin/activate
3. Install packages: pip install <package>

whisp> What about with poetry?

Using Poetry:
1. Install: curl -sSL https://install.python-poetry.org | python3 -
2. Create project: poetry new myproject
3. Add packages: poetry add requests
...

whisp> exit

Check Your Setup

If something isn't working:

# Check daemon status
whisp status

# Run diagnostics
whisp doctor

# View health metrics
whisp health

Next Steps

Shell Shortcuts — Master all shortcuts
Interactive Chat — Multi-turn conversations
Providers & Models — Switch AI providers
Configuration — Customize behavior

Quick Start

Quick Start

Start the Daemon

Your First Command

More Examples

Shell Shortcuts

Explain a Command

Preview Before Running

Pipe Mode

Error Recovery

Interactive Chat

Check Your Setup

Next Steps

On this page

Quick Start

Quick Start

Start the Daemon

Your First Command

More Examples

Shell Shortcuts

Explain a Command

Preview Before Running

Pipe Mode

Error Recovery

Interactive Chat

Check Your Setup

Next Steps

On this page