ccsidekick 1.0.0

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.
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ # ccsidekick
2
+
3
+ A Claude Code status line with an animated, reactive character and a full widget layer. It reads
4
+ from disk, so there is no Claude API call and no token spend on the render path. The only network is
5
+ an optional weekly currency-rate refresh and an optional account-usage lookup, both off the render
6
+ path and disableable.
7
+
8
+ ```bash
9
+ npx ccsidekick
10
+ ```
11
+
12
+ Running `ccsidekick` in a terminal opens the setup TUI: it picks a Claude config dir, lets you choose
13
+ a character, and wires the status line and the tool-call hooks into your `settings.json`. Remove it
14
+ with `npx ccsidekick uninstall`.
15
+
16
+ ## The two binaries
17
+
18
+ - **`ccsidekick-render`** is the hot path. Claude Code calls `ccsidekick-render render` on every
19
+ status-line tick and `ccsidekick-render classify` on every tool call. It loads no UI and runs under
20
+ plain Node.
21
+ - **`ccsidekick`** is the setup TUI and `uninstall`. It is the only entry point that loads the Ink
22
+ interface.
23
+
24
+ Characters ship as separate `@ccsidekick/pack-<name>` packages; `batman` is bundled as a runtime
25
+ dependency so a fresh install always has a character.
26
+
27
+ For the full feature tour, configuration reference, and contributor docs, see the
28
+ [repository README](https://github.com/krayong/ccsidekick#readme).
29
+
30
+ Licensed under MIT.