feature/crates-release
tmpl 62 lines 2.79 KB
Raw
1 <h1 align="center">siGit Code</h1>
2
3 <p align="center">
4 AI coding agent powered by local LLM via <a href="https://ondeinference.com">Onde Inference</a>.<br>
5 Runs on your machine. No API keys, no cloud.
6 </p>
7
8 <p align="center">
9 <a href="https://www.npmjs.com/package/@smbcloud/sigit"><img src="https://img.shields.io/npm/v/@smbcloud/sigit?style=flat-square&labelColor=17211D&color=235843" alt="npm"></a>
10 <a href="https://crates.io/crates/sigit"><img src="https://img.shields.io/crates/v/sigit?style=flat-square&labelColor=17211D&color=235843" alt="crates.io"></a>
11 <a href="https://pypi.org/project/sigit-code/"><img src="https://img.shields.io/pypi/v/sigit-code?style=flat-square&labelColor=17211D&color=235843" alt="PyPI"></a>
12 <a href="https://smbcloud.xyz"><img src="https://img.shields.io/badge/smbcloud.xyz-235843?style=flat-square&labelColor=17211D" alt="Website"></a>
13 <a href="https://github.com/getsigit/sigit/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-235843?style=flat-square&labelColor=17211D" alt="License"></a>
14 </p>
15
16 <br>
17
18 ## `${node_pkg}`
19
20 This is the npm distribution of siGit Code, a platform-specific binary package for [`@smbcloud/sigit`](https://www.npmjs.com/package/@smbcloud/sigit). You don't need to install it directly.
21
22 Install the main package and npm pulls in the right binary for your OS and architecture:
23
24 ```sh
25 npm install -g @smbcloud/sigit
26 ```
27
28 ## Other install methods
29
30 | Channel | Command |
31 |---------|---------|
32 | **npm** | `npm install -g @smbcloud/sigit` |
33 | **Homebrew** | `brew tap getsigit/tap && brew install sigit` |
34 | **pip** | `pip install sigit-code` |
35 | **uv** | `uvx --from sigit-code sigit` |
36 | **Cargo** | `cargo install sigit` |
37
38 ## Platform support
39
40 | Platform | Architecture | Package |
41 |----------|--------------|---------|
42 | macOS | Apple Silicon (arm64) | [`@smbcloud/sigit-darwin-arm64`](https://www.npmjs.com/package/@smbcloud/sigit-darwin-arm64) |
43 | macOS | Intel (x64) | [`@smbcloud/sigit-darwin-x64`](https://www.npmjs.com/package/@smbcloud/sigit-darwin-x64) |
44 | Linux | x64 | [`@smbcloud/sigit-linux-x64`](https://www.npmjs.com/package/@smbcloud/sigit-linux-x64) |
45 | Linux | arm64 | [`@smbcloud/sigit-linux-arm64`](https://www.npmjs.com/package/@smbcloud/sigit-linux-arm64) |
46 | Windows | x64 | [`@smbcloud/sigit-windows-x64`](https://www.npmjs.com/package/@smbcloud/sigit-windows-x64) |
47 | Windows | arm64 | [`@smbcloud/sigit-windows-arm64`](https://www.npmjs.com/package/@smbcloud/sigit-windows-arm64) |
48
49 ## Links
50
51 - [Homepage](https://smbcloud.xyz)
52 - [Source code](https://github.com/getsigit/sigit)
53 - [Issues](https://github.com/getsigit/sigit/issues)
54 - [Onde Inference](https://ondeinference.com)
55
56 ## License
57
58 [Apache-2.0](https://github.com/getsigit/sigit/blob/main/LICENSE)
59
60 ## Copyright
61
62 © 2026 [smbCloud](https://smbcloud.xyz/) (Splitfire AB).