|
6 | 6 | <p align="center"> |
7 | 7 | <b>The Next-Gen Terminal IDE www.ecli.io</b><br/> |
8 | 8 | A modern, AI-powered, extensible code editor for the terminal. |
9 | | - |
10 | 9 | </p> |
11 | 10 |
|
12 | 11 | <br> |
13 | 12 |
|
14 | | - |
15 | 13 | ### 🚀 About **Ecli** |
16 | 14 |
|
17 | | -**Ecli** (short for *Editor CLI*) is a next-generation terminal IDE. |
| 15 | +**Ecli** (short for *Editor CLI*) is a next-generation terminal IDE. |
18 | 16 | It brings the power of modern development tools into your terminal - fast, extensible, AI-ready. |
19 | 17 |
|
20 | 18 | <br> |
21 | 19 |
|
22 | 20 | #### ✨ Key Features |
23 | 21 |
|
24 | | -- 🧠 **AI Panel** - integrated assistant for code, docs, and refactoring |
| 22 | +- 🧠 **AI Panel** - integrated assistant for code, docs, and refactoring |
| 23 | +- 📂 **File Manager** - navigate and manage projects seamlessly |
| 24 | +- 🌱 **Git Panel** - stage, commit, push/pull directly in terminal |
| 25 | +- 🌈 **Syntax Highlighting** - powered by Tree-sitter, supports 70+ languages |
| 26 | +- 📝 **LSP Integration** - full Language Server Protocol support (autocomplete, diagnostics, go-to-definition) |
| 27 | +- 🐍 **Built-in Linters** - |
| 28 | + - **Ruff** (Python) integrated by default |
| 29 | + - Support for external linters across 70+ languages |
| 30 | +- ⚡ **Extensible Architecture** - plugins & themes |
| 31 | +- 🎨 **Dark/Light Themes** out of the box |
| 32 | +- 🔄 **Cross-platform**: Linux, macOS, and FreeBSD |
| 33 | + |
| 34 | +--- |
25 | 35 |
|
26 | | -- 📂 **File Manager** - navigate and manage projects seamlessly |
| 36 | +### 📦 Installation |
27 | 37 |
|
28 | | -- 🌱 **Git Panel** - stage, commit, push/pull directly in terminal |
| 38 | +#### 1. System Dependencies |
29 | 39 |
|
30 | | -- 🌈 **Syntax Highlighting** - powered by Tree-sitter, supports 70+ languages |
| 40 | +First, ensure you have the `ncurses` library installed. This is a required dependency for the terminal interface. |
31 | 41 |
|
32 | | -- 📝 **LSP Integration** - full Language Server Protocol support (autocomplete, diagnostics, go-to-definition) |
| 42 | +<details> |
| 43 | +<summary>Click to see installation commands for your OS</summary> |
33 | 44 |
|
34 | | -- 🐍 **Built-in Linters** - |
| 45 | +##### **On Debian/Ubuntu:** |
| 46 | + |
| 47 | +```bash |
| 48 | +sudo apt-get update && sudo apt-get install libncursesw5-dev |
| 49 | +``` |
| 50 | + |
| 51 | +##### **On Fedora/CentOS/RHEL:** |
| 52 | + |
| 53 | +```bash |
| 54 | +sudo dnf install ncurses-devel |
| 55 | +``` |
35 | 56 |
|
36 | | - - **Ruff** (Python) integrated by default |
| 57 | +##### **On Arch Linux:** |
37 | 58 |
|
38 | | - - Support for external linters across 70+ languages |
| 59 | +```bash |
| 60 | +sudo pacman -S ncurses |
| 61 | +``` |
39 | 62 |
|
40 | | -- ⚡ **Extensible Architecture** - plugins & themes |
| 63 | +##### **On FreeBSD:** |
41 | 64 |
|
42 | | -- 🎨 **Dark/Light Themes** out of the box |
| 65 | +```bash |
| 66 | +sudo pkg install ncurses |
| 67 | +``` |
43 | 68 |
|
44 | | -- 🔄 **Cross-platform**: Linux, macOS, Windows |
| 69 | +</details> |
45 | 70 |
|
46 | 71 | <br> |
47 | 72 |
|
| 73 | +#### 2. Install ECLI |
48 | 74 |
|
49 | | -### 📦 Installation |
| 75 | +You can install ECLI using a pre-compiled package (recommended) or with `pip`. |
| 76 | + |
| 77 | +##### **Option A: From a Package (Recommended)** |
50 | 78 |
|
51 | | -With pip: |
| 79 | +Download the appropriate package for your system from the [**GitHub Releases**](https://github.com/SSobol77/ecli/releases) page, then run the command for your OS. |
| 80 | + |
| 81 | +**On Debian/Ubuntu:** |
52 | 82 |
|
53 | 83 | ```bash |
54 | | -pip install ecli |
| 84 | +# Replace with the actual downloaded filename |
| 85 | +sudo apt install ./ecli-0.1.0_amd64.deb |
55 | 86 | ``` |
56 | 87 |
|
| 88 | +**On Fedora/CentOS/RHEL:** |
57 | 89 |
|
| 90 | +```bash |
| 91 | +# Replace with the actual downloaded filename |
| 92 | +sudo dnf install ./ecli-0.1.0-1.x86_64.rpm |
| 93 | +``` |
| 94 | + |
| 95 | +**On FreeBSD:** |
| 96 | + |
| 97 | +```bash |
| 98 | +# Replace with the actual downloaded filename |
| 99 | +sudo pkg install ./ecli-0.1.0.pkg |
| 100 | +``` |
| 101 | + |
| 102 | +**On Arch Linux:** |
| 103 | + |
| 104 | +The recommended method for Arch Linux is to install from the Arch User Repository (AUR). Once the package is available on the AUR, you can install it using an AUR helper like `yay`: |
| 105 | + |
| 106 | +```bash |
| 107 | +yay -S ecli |
| 108 | +``` |
| 109 | + |
| 110 | +*(Note: The `ecli` package must be submitted to the AUR first.)* |
58 | 111 |
|
59 | 112 | <br> |
| 113 | + |
| 114 | +##### **Option B: With pip** |
| 115 | + |
| 116 | +This method requires you to have Python 3.11+ and `pip` installed, in addition to the system dependencies mentioned above. |
| 117 | + |
| 118 | +```bash |
| 119 | +pip install ecli |
| 120 | +``` |
0 commit comments