|
1 | | -<h1 align="center">Cortex</h1> |
| 1 | +<h1 align="center"> |
| 2 | + <img src="./assets/banner.jpg" alt="Cortex" width="100%"> |
| 3 | +</h1> |
2 | 4 |
|
3 | | -The **Agent-Native Development CLI**. Our agent is continuously **fine-tuned** through community-driven incentives, enabling contributors to collaborate and compete to produce the best possible AI agent. |
4 | | - |
5 | | ---- |
| 5 | +<h3 align="center">The Agent-Native Development CLI</h3> |
6 | 6 |
|
7 | 7 | <p align="center"> |
8 | | - <img src="./assets/banner.jpg" alt="Cortex Banner" width="100%"> |
| 8 | + Our agent is continuously <strong>fine-tuned</strong> through community-driven incentives, enabling contributors to collaborate and compete to produce the best possible AI agent. |
9 | 9 | </p> |
10 | 10 |
|
11 | 11 | <p align="center"> |
12 | | - Works on CLI. Web coming soon. |
| 12 | + <a href="https://github.com/CortexLM/cortex/releases"><img src="https://img.shields.io/github/v/release/CortexLM/cortex?style=flat-square&color=blue" alt="Release"></a> |
| 13 | + <a href="https://discord.gg/cortexfoundation"><img src="https://img.shields.io/discord/1234567890?style=flat-square&logo=discord&logoColor=white&color=5865F2" alt="Discord"></a> |
| 14 | + <a href="https://twitter.com/CortexLM"><img src="https://img.shields.io/twitter/follow/CortexLM?style=flat-square&logo=twitter&color=1DA1F2" alt="Twitter"></a> |
13 | 15 | </p> |
14 | 16 |
|
15 | 17 | <p align="center"> |
16 | | - <a href="https://github.com/CortexLM/cortex" target="_blank">GitHub</a> • |
17 | | - <a href="https://discord.gg/cortexfoundation" target="_blank">Discord</a> • |
18 | | - <a href="https://twitter.com/CortexLM" target="_blank">Twitter</a> • |
19 | | - <a href="./docs/CONTRIBUTING.md" target="_blank">Contributing</a> |
| 18 | + <a href="#installation">Installation</a> • |
| 19 | + <a href="#quick-start">Quick Start</a> • |
| 20 | + <a href="https://discord.gg/cortexfoundation">Discord</a> • |
| 21 | + <a href="https://twitter.com/CortexLM">Twitter</a> • |
| 22 | + <a href="./CHANGELOG.md">Changelog</a> |
20 | 23 | </p> |
21 | 24 |
|
| 25 | +--- |
| 26 | + |
22 | 27 | ## Installation |
23 | 28 |
|
| 29 | +### Linux & macOS |
| 30 | + |
24 | 31 | ```bash |
25 | | -curl -fsSL https://cortex.foundation/cli | sh |
| 32 | +curl -fsSL https://software.cortex.foundation/install.sh | sh |
| 33 | +``` |
| 34 | + |
| 35 | +Or with wget: |
| 36 | + |
| 37 | +```bash |
| 38 | +wget -qO- https://software.cortex.foundation/install.sh | sh |
| 39 | +``` |
| 40 | + |
| 41 | +### Windows (PowerShell) |
| 42 | + |
| 43 | +```powershell |
| 44 | +irm https://software.cortex.foundation/install.ps1 | iex |
26 | 45 | ``` |
27 | 46 |
|
| 47 | +### Install a specific version |
| 48 | + |
28 | 49 | ```bash |
29 | | -wget -qO- https://cortex.foundation/cli | sh |
| 50 | +# Linux & macOS |
| 51 | +CORTEX_VERSION=0.0.1c curl -fsSL https://software.cortex.foundation/install.sh | sh |
| 52 | + |
| 53 | +# Windows PowerShell |
| 54 | +$env:CORTEX_VERSION="0.0.1c"; irm https://software.cortex.foundation/install.ps1 | iex |
30 | 55 | ``` |
31 | 56 |
|
32 | | -## Supported Platforms |
| 57 | +### Manual Download |
| 58 | + |
| 59 | +| Platform | Architecture | Download | |
| 60 | +|----------|--------------|----------| |
| 61 | +| **Linux** | x86_64 | [cortex.tar.gz](https://software.cortex.foundation/v1/assets/linux-x86_64/latest/cortex.tar.gz) | |
| 62 | +| **Linux** | ARM64 | [cortex.tar.gz](https://software.cortex.foundation/v1/assets/linux-aarch64/latest/cortex.tar.gz) | |
| 63 | +| **macOS** | Apple Silicon | [cortex.tar.gz](https://software.cortex.foundation/v1/assets/darwin-aarch64/latest/cortex.tar.gz) | |
| 64 | +| **macOS** | Intel | [cortex.tar.gz](https://software.cortex.foundation/v1/assets/darwin-x86_64/latest/cortex.tar.gz) | |
| 65 | +| **Windows** | x86_64 | [cortex.zip](https://software.cortex.foundation/v1/assets/windows-x86_64/latest/cortex.zip) | |
| 66 | +| **Windows** | ARM64 | [cortex.zip](https://software.cortex.foundation/v1/assets/windows-aarch64/latest/cortex.zip) | |
| 67 | + |
| 68 | +--- |
33 | 69 |
|
34 | | -| Platform | Architecture | |
35 | | -|----------|--------------| |
36 | | -| macOS | Apple Silicon (arm64) | |
37 | | -| macOS | Intel (x86_64) | |
38 | | -| Linux | x86_64 | |
39 | | -| Linux | arm64 | |
40 | | -| Windows | x86_64 | |
41 | | -| Windows | arm64 | |
| 70 | +## Quick Start |
| 71 | + |
| 72 | +```bash |
| 73 | +# Start a new session |
| 74 | +cortex |
| 75 | + |
| 76 | +# Or run a specific command |
| 77 | +cortex "explain this codebase" |
| 78 | +``` |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## Update |
| 83 | + |
| 84 | +Cortex can update itself: |
| 85 | + |
| 86 | +```bash |
| 87 | +cortex upgrade |
| 88 | +``` |
| 89 | + |
| 90 | +Or reinstall using the installation script. |
| 91 | + |
| 92 | +--- |
| 93 | + |
| 94 | +## Uninstall |
| 95 | + |
| 96 | +### Linux & macOS |
| 97 | + |
| 98 | +```bash |
| 99 | +sudo rm /usr/local/bin/Cortex |
| 100 | +# Or if installed to ~/.local/bin |
| 101 | +rm ~/.local/bin/Cortex |
| 102 | +``` |
| 103 | + |
| 104 | +### Windows |
| 105 | + |
| 106 | +```powershell |
| 107 | +Remove-Item "$env:LOCALAPPDATA\Cortex\Cortex.exe" |
| 108 | +# Remove from PATH via System Properties > Environment Variables |
| 109 | +``` |
| 110 | + |
| 111 | +--- |
42 | 112 |
|
43 | 113 | ## Contributing |
44 | 114 |
|
45 | | -We welcome contributions from the community! See our [Contributing Guide](./docs/CONTRIBUTING.md) for details on how to contribute and how to create an issue. |
| 115 | +We welcome contributions from the community! See our [Contributing Guide](./docs/CONTRIBUTING.md) for details. |
| 116 | + |
| 117 | +--- |
46 | 118 |
|
47 | 119 | ## License |
48 | 120 |
|
|
0 commit comments