Skip to content

Commit 176ff53

Browse files
Docs: Update Readme
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com> Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
1 parent 7f5ade3 commit 176ff53

File tree

1 file changed

+78
-63
lines changed

1 file changed

+78
-63
lines changed

readme.md

Lines changed: 78 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,103 @@
1-
# [Command Code](https://commandcode.ai)
2-
3-
Command code with your taste. Check it out at [CommandCode.ai](https://commandcode.ai)
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-
## Docs
8-
9-
Please follow the full documentation at [CommandCode.ai/docs](https://commandcode.ai/docs)
10-
11-
## Installation
1+
<p align="center">
2+
<a href="https://commandcode.ai">
3+
<img src=".github/commandcode/logo/command-code-logo-white-bg.svg" alt="Command Code logo" width="520" />
4+
</a>
5+
</p>
6+
7+
<p align="center"><strong>The coding agent that learns your coding taste.</strong></p>
8+
9+
<p align="center">
10+
Command Code ships features, fixes bugs, writes tests, reviews PRs, and keeps adapting to how you and your team actually code.
11+
</p>
12+
13+
<p align="center">
14+
<a href="https://www.npmjs.com/package/command-code"><img src="https://img.shields.io/npm/v/command-code?style=flat-square&logo=npm&label=npm" alt="npm version" /></a>
15+
<a href="https://commandcode.ai/docs"><img src="https://img.shields.io/badge/docs-commandcode.ai-111827?style=flat-square&logo=readthedocs" alt="Docs" /></a>
16+
<img src="https://img.shields.io/badge/built%20with-command%20code-7c3aed?style=flat-square" alt="Built with Command Code" />
17+
</p>
18+
19+
<p align="center">
20+
<a href="https://commandcode.ai/docs/quickstart"><strong>Quickstart</strong></a>
21+
·
22+
<a href="https://commandcode.ai/docs">Docs</a>
23+
·
24+
<a href="https://commandcode.ai/docs/workflows">Workflows</a>
25+
·
26+
<a href="https://commandcode.ai/docs/taste">Taste</a>
27+
·
28+
<a href="https://commandcode.ai/launch">Launch</a>
29+
·
30+
<a href="https://commandcode.ai/discord">Discord</a>
31+
</p>
32+
33+
<p align="center">
34+
<img src="https://commandcode.ai/docs/top.png" alt="Command Code terminal preview" width="1100" />
35+
</p>
36+
37+
> AI coding agents usually write acceptable code. Command Code is built to write code that feels like yours.
38+
39+
## Why Command Code
40+
41+
- **Learns your coding taste** from accepts, rejects, edits, and repeated preferences.
42+
- **Works where you already work** with an interactive terminal workflow, slash commands, checkpoints, and Bash execution.
43+
- **Ships real software** across features, bug fixes, refactors, reviews, and pull requests.
44+
- **Keeps team conventions portable** with `npx taste push` and `npx taste pull`.
45+
46+
Want the deeper story behind Taste and the correction-loop problem? Read the [launch announcement](https://commandcode.ai/launch).
47+
48+
## Quickstart
1249

1350
```bash
1451
npm i -g command-code
52+
cd your-project
53+
cmd
1554
```
1655

17-
## Usage
18-
19-
Start an interactive chat session:
56+
Helpful first commands:
2057

2158
```bash
22-
cmd
59+
cmd --help
60+
cmd --version
61+
cmd status
2362
```
2463

25-
Use `cmd --help` to see all available options.
26-
27-
## What is Taste?
28-
29-
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.
30-
31-
**What Taste learns:**
32-
33-
- Your coding style preferences (const vs let, functional vs class components)
34-
- Framework and library choices
35-
- Code structure and patterns you prefer
36-
- Testing and documentation practices
37-
- Communication style preferences
38-
39-
**How it works:**
64+
Need the full onboarding flow? Start with the [Quickstart guide](https://commandcode.ai/docs/quickstart).
4065

41-
- Learns from explicit preferences ("Please always use TypeScript")
42-
- Learns from repeated corrections you make
43-
- Creates rules with confidence scores (0.0-1.0)
44-
- Only applies rules with confidence > 0.3
45-
- Organizes learnings by category when you have more than 5
66+
## Explore Command Code
4667

47-
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.
68+
### Taste
4869

49-
**Try it:** State your preferences or make corrections during chat to see taste learning in action!
70+
Command Code learns the micro-decisions you usually never bother to document: style preferences, framework choices, project structure, testing habits, and how you like code to evolve over time.
5071

51-
## Interactive Commands
72+
Learn more: [Taste docs](https://commandcode.ai/docs/taste)
5273

53-
Available during chat sessions:
74+
### Interactive terminal workflow
5475

55-
- `/login` - Authenticate with CommandCode via browser (zero-copy auth)
56-
- `/logout` - Sign out from CommandCode
57-
- `/taste` - Toggle taste learning on or off
58-
- `/share` - Create a shareable link for the conversation
59-
- `/unshare` - Stop sharing the conversation
60-
- `/resume` - Resume a past conversation
61-
- `/memory` - Manage project memory (persistent context)
62-
- `/clear` - Clear the conversation history
76+
Use `/` to discover commands, `!` to run Bash and feed the output back into the session, `@` to mention files and directories, and checkpoints to safely rewind when you want to try a different path.
6377

64-
## Authentication
78+
Learn more: [Interactive Mode](https://commandcode.ai/docs/core-concepts/interactive-mode)
6579

66-
CommandCode uses browser-based authentication for a secure, seamless login experience:
80+
### Workflow-first execution
6781

68-
1. Run `/login` in the CLI
69-
2. Your browser opens automatically to CommandCode Studio
70-
3. Click "Approve" to authorize the CLI
71-
4. You're authenticated! The CLI receives your credentials automatically
82+
Command Code is built for real development loops: understanding a new codebase, fixing bugs from stack traces, refactoring with checkpoints, reviewing pull requests, and sharing sessions with teammates.
7283

73-
No need to copy-paste API keys - authentication happens securely in the background.
84+
Learn more: [Workflows](https://commandcode.ai/docs/workflows)
7485

75-
## Try These Examples
86+
## Choose your next step
7687

77-
- Build a chrome extension to snooze a tab for 5s, 1min, and 10mins.
78-
- Analyze this repo and suggest three high impact PRs
79-
- Build a zero-config, single-file Node.js/TypeScript CLI named `passgen` that generates a random secure password.
80-
- Build a modern React financial dashboard using shadcn/ui components with stock prices, market indices, and currency converter.
88+
| Goal | Best next link |
89+
| --- | --- |
90+
| Install and run your first session | [Quickstart](https://commandcode.ai/docs/quickstart) |
91+
| Understand how Taste works | [Taste](https://commandcode.ai/docs/taste) |
92+
| Learn slash commands and shortcuts | [Interactive Mode](https://commandcode.ai/docs/core-concepts/interactive-mode) |
93+
| See flags, subcommands, and command reference | [CLI Reference](https://commandcode.ai/docs/reference/cli) |
94+
| Browse practical day-to-day usage patterns | [Workflows](https://commandcode.ai/docs/workflows) |
8195

82-
## Beta Release & Feedback
96+
## Docs and community
8397

84-
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
98+
- Docs: [commandcode.ai/docs](https://commandcode.ai/docs)
99+
- Discord: [commandcode.ai/discord](https://commandcode.ai/discord)
100+
- Launch announcement: [commandcode.ai/launch](https://commandcode.ai/launch)
85101

86-
## Author
87102

88-
[Ahmad Awais](https://x.com/MrAhmadAwais)
103+
**Built with [Command Code](https://commandcode.ai).**

0 commit comments

Comments
 (0)