Edison User Documentation
Welcome to the Edison user documentation! This guide will help you understand how to use Edison effectively in your day-to-day terminal usage.
Table of Contents
Quick Start
Edison is a command-line tool that translates natural language into shell commands. To use Edison, simply type edison followed by your query:
edison how to compress all jpg files in the current directory
Edison will generate the appropriate command and ask for your confirmation before executing it.
Feature Overview
flowchart TD
A[Edison CLI] --> B[Natural Language Processing]
B --> C{Command Generation}
C --> D[Command Execution]
C --> E[Command Explanation]
C --> F[Interactive Mode]
style A fill:#f9d5e5,stroke:#333,stroke-width:2px
style B fill:#eeeeee,stroke:#333,stroke-width:2px
style C fill:#d3f6db,stroke:#333,stroke-width:2px
style D fill:#d3f6f5,stroke:#333,stroke-width:2px
style E fill:#d3f6f5,stroke:#333,stroke-width:2px
style F fill:#d3f6f5,stroke:#333,stroke-width:2px
Edison offers several key features:
- Natural Language Command Generation: Describe what you want to do in plain English
- Command Explanation: Get explanations for complex commands
- Interactive Mode: Use Edison in an interactive shell
- Shell Integration: Works with your default shell
- Configurable: Adjust settings via
edison.yaml
Check the individual documentation pages for more detailed information on each feature.