Skip to content

Commit fecb32d

Browse files
committed
📖 DOC: readme
0 parents  commit fecb32d

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

readme.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# CommandCode
2+
3+
Command code with your taste.
4+
5+
> Stop fixing sloppy AI code. Command Code continuously learns your coding taste. Powered by taste-1 applied meta neuro-symbolic AI.
6+
7+
## Installation
8+
9+
```bash
10+
npm i -g command-code
11+
```
12+
13+
## Usage
14+
15+
Start an interactive chat session:
16+
17+
```bash
18+
cmd
19+
```
20+
21+
Use `cmd --help` to see all available options.
22+
23+
## What is Taste?
24+
25+
Taste learning automatically learns your coding preferences and style from conversations. It analyzes patterns in your corrections and stated preferences, storing them in project-specific files.
26+
27+
**What Taste learns:**
28+
29+
- Your coding style preferences (const vs let, functional vs class components)
30+
- Framework and library choices
31+
- Code structure and patterns you prefer
32+
- Testing and documentation practices
33+
- Communication style preferences
34+
35+
**How it works:**
36+
37+
- Learns from explicit preferences ("Please always use TypeScript")
38+
- Learns from repeated corrections you make
39+
- Creates rules with confidence scores (0.0-1.0)
40+
- Only applies rules with confidence > 0.3
41+
- Organizes learnings by category when you have more than 5
42+
43+
Taste learning is **enabled by default**. Learnings are automatically stored in `.commandcode/taste/taste.md` with confidence scores. As it grows, learnings automatically split into multiple files and folders by category (e.g., `cli/`, `typescript/`, `architecture/`). Use `/taste` in the CLI to toggle it on or off.
44+
45+
**Try it:** State your preferences or make corrections during chat to see taste learning in action!
46+
47+
## Interactive Commands
48+
49+
Available during chat sessions:
50+
51+
- `/login` - Authenticate with CommandCode via browser (zero-copy auth)
52+
- `/logout` - Sign out from CommandCode
53+
- `/taste` - Toggle taste learning on or off
54+
- `/share` - Create a shareable link for the conversation
55+
- `/unshare` - Stop sharing the conversation
56+
- `/resume` - Resume a past conversation
57+
- `/memory` - Manage project memory (persistent context)
58+
- `/clear` - Clear the conversation history
59+
60+
## Authentication
61+
62+
CommandCode uses browser-based authentication for a secure, seamless login experience:
63+
64+
1. Run `/login` in the CLI
65+
2. Your browser opens automatically to CommandCode Studio
66+
3. Click "Approve" to authorize the CLI
67+
4. You're authenticated! The CLI receives your credentials automatically
68+
69+
No need to copy-paste API keys - authentication happens securely in the background.
70+
71+
## Try These Examples
72+
73+
- Build a chrome extension to snooze a tab for 5s, 1min, and 10mins.
74+
- Analyze this repo and suggest three high impact PRs
75+
- Build a zero-config, single-file Node.js/TypeScript CLI named `passgen` that generates a random secure password.
76+
- Build a modern React financial dashboard using shadcn/ui components with stock prices, market indices, and currency converter.
77+
78+
## Beta Release & Feedback
79+
80+
This is a beta version, and we are actively working on improvements. Expect some rough edges and occasional bugs as we refine the experience. Your feedback is invaluable. Join our Discord community: https://commandcode.ai/discord
81+
82+
## Author
83+
84+
[Ahmad Awais](https://x.com/MrAhmadAwais)

0 commit comments

Comments
 (0)