nip/docs/shell-interface.md

77 lines
1.8 KiB
Markdown

# NIP Shell Interface
## Overview
The NIP Shell provides an interactive command-line interface for package management with advanced features including Content Addressable Storage (CAS) integration, package variant analysis, and comprehensive integrity monitoring.
## Features
### Core Package Management
- **Search**: Enhanced package search with CAS paths and Content Identifiers (CIDs)
- **Install/Remove**: Package installation and removal with dependency resolution
- **List**: Display installed packages with CAS analysis and integrity status
- **Show**: Detailed package information including dependencies and file listings
### Session Management
- **Track Switching**: Switch between package streams (stable, testing, dev, lts)
- **Command History**: Persistent command history across sessions
- **Status Display**: System status with track, channels, and transaction information
### Advanced Features
- **CAS Integration**: Content Addressable Storage paths and identifiers
- **Integrity Monitoring**: Package verification and forensic diagnosis
- **Context-Aware Help**: Comprehensive help system with usage examples
- **Interactive Prompts**: Dynamic prompts showing current track and status
## Usage
### Starting the Shell
```bash
nip shell
```
### Basic Commands
```bash
# Search for packages
search firefox
# Install a package
install firefox
# Show package information
show firefox
# List installed packages
list
# Remove a package
remove firefox
```
### Track Management
```bash
# Switch to testing track
track testing
# Switch back to stable
track stable
# Show current status
status
```
### Advanced Commands
```bash
# Verify package integrity
verify firefox
# Run forensic diagnosis
diagnose blake3:abc123
# Show command history
history
```
## Command Reference
See `help` command in the shell for complete command reference.