@taoeffects/crush 0.70.0-taoeffect.1 → 0.70.0-taoeffect.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +10 -134
  2. package/install.js +1 -1
  3. package/package.json +17 -17
package/README.md CHANGED
@@ -23,147 +23,23 @@
23
23
 
24
24
  ## Installation
25
25
 
26
- Use a package manager:
26
+ Install the Tao Effect fork from npm:
27
27
 
28
28
  ```bash
29
- # Homebrew
30
- brew install charmbracelet/tap/crush
31
-
32
- # NPM
33
- npm install -g @charmland/crush
34
-
35
- # Arch Linux (btw)
36
- yay -S crush-bin
37
-
38
- # Nix
39
- nix run github:numtide/nix-ai-tools#crush
40
-
41
- # FreeBSD
42
- pkg install crush
43
- ```
44
-
45
- Windows users:
46
-
47
- ```bash
48
- # Winget
49
- winget install charmbracelet.crush
50
-
51
- # Scoop
52
- scoop bucket add charm https://github.com/charmbracelet/scoop-bucket.git
53
- scoop install crush
29
+ npm install -g @taoeffects/crush
54
30
  ```
55
31
 
56
- <details>
57
- <summary><strong>Nix (NUR)</strong></summary>
58
-
59
- Crush is available via the official Charm [NUR](https://github.com/nix-community/NUR) in `nur.repos.charmbracelet.crush`, which is the most up-to-date way to get Crush in Nix.
32
+ Fork releases use versions such as `0.70.0-taoeffect.1`: `0.70.0` identifies
33
+ the upstream Crush release, and `taoeffect.1` identifies this fork's release
34
+ iteration.
60
35
 
61
- You can also try out Crush via the NUR with `nix-shell`:
36
+ Or just install it with Go from a clone:
62
37
 
63
38
  ```bash
64
- # Add the NUR channel.
65
- nix-channel --add https://github.com/nix-community/NUR/archive/main.tar.gz nur
66
- nix-channel --update
67
-
68
- # Get Crush in a Nix shell.
69
- nix-shell -p '(import <nur> { pkgs = import <nixpkgs> {}; }).repos.charmbracelet.crush'
70
- ```
71
-
72
- ### NixOS & Home Manager Module Usage via NUR
73
-
74
- Crush provides NixOS and Home Manager modules via NUR.
75
- You can use these modules directly in your flake by importing them from NUR. Since it auto detects whether its a home manager or nixos context you can use the import the exact same way :)
76
-
77
- ```nix
78
- {
79
- inputs = {
80
- nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
81
- nur.url = "github:nix-community/NUR";
82
- };
83
-
84
- outputs = { self, nixpkgs, nur, ... }: {
85
- nixosConfigurations.your-hostname = nixpkgs.lib.nixosSystem {
86
- system = "x86_64-linux";
87
- modules = [
88
- nur.modules.nixos.default
89
- nur.repos.charmbracelet.modules.crush
90
- {
91
- programs.crush = {
92
- enable = true;
93
- settings = {
94
- providers = {
95
- openai = {
96
- id = "openai";
97
- name = "OpenAI";
98
- base_url = "https://api.openai.com/v1";
99
- type = "openai";
100
- api_key = "sk-fake123456789abcdef...";
101
- models = [
102
- {
103
- id = "gpt-4";
104
- name = "GPT-4";
105
- }
106
- ];
107
- };
108
- };
109
- lsp = {
110
- go = { command = "gopls"; enabled = true; };
111
- nix = { command = "nil"; enabled = true; };
112
- };
113
- options = {
114
- context_paths = [ "/etc/nixos/configuration.nix" ];
115
- tui = { compact_mode = true; };
116
- debug = false;
117
- };
118
- };
119
- };
120
- }
121
- ];
122
- };
123
- };
124
- }
125
- ```
126
-
127
- </details>
128
-
129
- <details>
130
- <summary><strong>Debian/Ubuntu</strong></summary>
131
-
132
- ```bash
133
- sudo mkdir -p /etc/apt/keyrings
134
- curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
135
- echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
136
- sudo apt update && sudo apt install crush
137
- ```
138
-
139
- </details>
140
-
141
- <details>
142
- <summary><strong>Fedora/RHEL</strong></summary>
143
-
144
- ```bash
145
- echo '[charm]
146
- name=Charm
147
- baseurl=https://repo.charm.sh/yum/
148
- enabled=1
149
- gpgcheck=1
150
- gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
151
- sudo yum install crush
152
- ```
153
-
154
- </details>
155
-
156
- Or, download it:
157
-
158
- - [Packages][releases] are available in Debian and RPM formats
159
- - [Binaries][releases] are available for Linux, macOS, Windows, FreeBSD, OpenBSD, and NetBSD
160
-
161
- [releases]: https://github.com/charmbracelet/crush/releases
162
-
163
- Or just install it with Go:
164
-
165
- ```
166
- go install github.com/charmbracelet/crush@latest
39
+ git clone https://github.com/taoeffect/crush.git
40
+ cd crush
41
+ git checkout taoeffect
42
+ go install .
167
43
  ```
168
44
 
169
45
  > [!WARNING]
package/install.js CHANGED
@@ -6,7 +6,7 @@ import { Readable } from "node:stream";
6
6
  import { pipeline } from "node:stream/promises";
7
7
 
8
8
  import { ProxyAgent } from "proxy-agent";
9
- import tar from "tar";
9
+ import * as tar from "tar";
10
10
 
11
11
  import {
12
12
  assertSafeArchivePath,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@taoeffects/crush",
3
3
  "type": "module",
4
- "version": "0.70.0-taoeffect.1",
4
+ "version": "0.70.0-taoeffect.4",
5
5
  "description": "A terminal-based AI coding assistant forked from Charm Crush.",
6
6
  "scripts": {
7
7
  "postinstall": "node install.js",
@@ -33,43 +33,43 @@
33
33
  "repo": "taoeffect/crush",
34
34
  "archives": {
35
35
  "linux-x64": {
36
- "name": "crush_0.70.0-taoeffect.1_Linux_x86_64.tar.gz",
37
- "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Linux_x86_64.tar.gz",
36
+ "name": "crush_0.70.0-taoeffect.4_Linux_x86_64.tar.gz",
37
+ "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.4/crush_0.70.0-taoeffect.4_Linux_x86_64.tar.gz",
38
38
  "checksum": {
39
39
  "algorithm": "sha256",
40
- "digest": "5cc75b9628166c0247a77d5213887598039e32c2a0daebbb09ce473ad5515d9f"
40
+ "digest": "219eeee00f74b8bdf1e206c894a6d681f0c65a1721553b3c86c427456d7dc4e6"
41
41
  },
42
- "wrappedIn": "crush_0.70.0-taoeffect.1_Linux_x86_64",
42
+ "wrappedIn": "crush_0.70.0-taoeffect.4_Linux_x86_64",
43
43
  "bin": "crush"
44
44
  },
45
45
  "linux-arm64": {
46
- "name": "crush_0.70.0-taoeffect.1_Linux_arm64.tar.gz",
47
- "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Linux_arm64.tar.gz",
46
+ "name": "crush_0.70.0-taoeffect.4_Linux_arm64.tar.gz",
47
+ "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.4/crush_0.70.0-taoeffect.4_Linux_arm64.tar.gz",
48
48
  "checksum": {
49
49
  "algorithm": "sha256",
50
- "digest": "4db393c3b07f03e117ce09d3a36ccfd2951e1600f15363a632b008e59b3114ae"
50
+ "digest": "fe15eaf5eafb72a5c8aa6f62af0c8eb9a1ffb3ef2d099f6070a48905789a2ed1"
51
51
  },
52
- "wrappedIn": "crush_0.70.0-taoeffect.1_Linux_arm64",
52
+ "wrappedIn": "crush_0.70.0-taoeffect.4_Linux_arm64",
53
53
  "bin": "crush"
54
54
  },
55
55
  "darwin-x64": {
56
- "name": "crush_0.70.0-taoeffect.1_Darwin_x86_64.tar.gz",
57
- "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Darwin_x86_64.tar.gz",
56
+ "name": "crush_0.70.0-taoeffect.4_Darwin_x86_64.tar.gz",
57
+ "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.4/crush_0.70.0-taoeffect.4_Darwin_x86_64.tar.gz",
58
58
  "checksum": {
59
59
  "algorithm": "sha256",
60
- "digest": "c63b4689d7b509335daf6ed80f542f0d342afaa21c0303ed766d1625fc31c717"
60
+ "digest": "ac160ab67f976539f1e458bb55fd1cb942a0eb420157a307b2ffbf00bb7eca6a"
61
61
  },
62
- "wrappedIn": "crush_0.70.0-taoeffect.1_Darwin_x86_64",
62
+ "wrappedIn": "crush_0.70.0-taoeffect.4_Darwin_x86_64",
63
63
  "bin": "crush"
64
64
  },
65
65
  "darwin-arm64": {
66
- "name": "crush_0.70.0-taoeffect.1_Darwin_arm64.tar.gz",
67
- "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.1/crush_0.70.0-taoeffect.1_Darwin_arm64.tar.gz",
66
+ "name": "crush_0.70.0-taoeffect.4_Darwin_arm64.tar.gz",
67
+ "url": "https://github.com/taoeffect/crush/releases/download/v0.70.0-taoeffect.4/crush_0.70.0-taoeffect.4_Darwin_arm64.tar.gz",
68
68
  "checksum": {
69
69
  "algorithm": "sha256",
70
- "digest": "93690d7e33900fcf99278ce09531d87aa81cec8e577922a823c17c00d3a409d6"
70
+ "digest": "b13268045e591ce4c8144bfcccf94b6718e325a20e257d67212002a3964eebde"
71
71
  },
72
- "wrappedIn": "crush_0.70.0-taoeffect.1_Darwin_arm64",
72
+ "wrappedIn": "crush_0.70.0-taoeffect.4_Darwin_arm64",
73
73
  "bin": "crush"
74
74
  }
75
75
  }