chad-code 1.3.5 → 1.3.6
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 +54 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,63 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Chad Code
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AI-powered coding assistant for your terminal.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
4
6
|
|
|
5
7
|
```bash
|
|
6
|
-
|
|
8
|
+
npm install -g chad-code
|
|
7
9
|
```
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
Or run directly with npx:
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
|
-
|
|
14
|
+
npx chad-code
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
1. Install globally: `npm install -g chad-code`
|
|
20
|
+
2. Run in any project directory: `chad-code`
|
|
21
|
+
3. Enter your Chadcode API key when prompted
|
|
22
|
+
4. Start coding with AI assistance!
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **AI-Powered Coding**: Get intelligent code suggestions, explanations, and refactoring help
|
|
27
|
+
- **Multi-File Operations**: Create, edit, and manage multiple files in a single session
|
|
28
|
+
- **Terminal Native**: Works directly in your terminal with a beautiful TUI
|
|
29
|
+
- **Tool Execution**: Run commands, tests, and scripts with AI guidance
|
|
30
|
+
- **Context Aware**: Understands your project structure and codebase
|
|
31
|
+
|
|
32
|
+
## Requirements
|
|
33
|
+
|
|
34
|
+
- Node.js 18+ or Bun
|
|
35
|
+
- A Chadcode API key (get one at [chadcode.dev](https://chadcode.dev))
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Start in current directory
|
|
41
|
+
chad-code
|
|
42
|
+
|
|
43
|
+
# Start in a specific directory
|
|
44
|
+
chad-code /path/to/project
|
|
45
|
+
|
|
46
|
+
# Show version
|
|
47
|
+
chad-code --version
|
|
48
|
+
|
|
49
|
+
# Show help
|
|
50
|
+
chad-code --help
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Documentation
|
|
54
|
+
|
|
55
|
+
Visit [chadcode-docs.docsalot.dev](https://chadcode-docs.docsalot.dev/getting-started) for full documentation.
|
|
56
|
+
|
|
57
|
+
## Support
|
|
58
|
+
|
|
59
|
+
- Website: [chadcode.dev](https://chadcode.dev)
|
|
60
|
+
|
|
61
|
+
## License
|
|
62
|
+
|
|
63
|
+
MIT
|