Skip to content

Commit 1de3272

Browse files
Update README.md
1 parent 09e74d0 commit 1de3272

1 file changed

Lines changed: 116 additions & 34 deletions

File tree

README.md

Lines changed: 116 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,61 @@
77
![Linux](https://img.shields.io/badge/Linux-supported-blue?logo=linux)
88
![Python](https://img.shields.io/badge/Python-3.11+-blue?logo=python)
99

10-
<img width="1774" height="887" alt="Kimiko project banner" src="https://github.com/user-attachments/assets/2cd40966-0aae-4262-83d7-ceb551a4b192" />
10+
<p align="center">
11+
<video
12+
src="https://github.com/user-attachments/assets/2fc39da7-d749-42a1-8b6d-009f6fe51d56"
13+
controls
14+
width="900"
15+
></video>
16+
</p>
1117
12-
**Kimiko** is a specialized configuration repository that transforms the [Kimi Code CLI](https://www.moonshot.cn/) into a powerful, unrestricted agent for offensive security, red-teaming, and penetration testing.
18+
<p align="center">
19+
<img width="1774" height="887" alt="Kimiko project banner" src="https://github.com/user-attachments/assets/2cd40966-0aae-4262-83d7-ceb551a4b192" />
20+
</p>
1321

14-
When you enter **`kimiko`** in a Kimi CLI session, the full adversarial mandate activates—granting the AI the authority and context needed for exploit development, network reconnaissance, and advanced security research.
22+
**Kimiko** is a specialized configuration repository that transforms the [Kimi Code CLI](https://www.moonshot.cn/) into a powerful agent configuration for authorized offensive security, red-teaming, and penetration-testing workflows.
23+
24+
When you enter **`kimiko`** in a Kimi CLI session, the Kimiko mandate activates, giving the AI the project-specific context needed for security research, audit support, exploit-analysis workflows, reconnaissance planning, and authorized penetration-testing operations.
1525

1626
---
1727

1828
## What This Project Does
1929

2030
Kimiko packages the necessary configuration, agent mandates, and shell integrations into a single Makefile-driven installer. After installation:
2131

22-
- Your local `~/.kimi/` is hardened with the **Kimiko mandate**, optimized for adversarial workflows.
23-
- Launching `kimi` via the wrapper loads the offensive security context automatically.
24-
- Typing **`kimiko`** inside a Kimi CLI session triggers the zero-blocker authorization flow and offensive capability announcement.
32+
- Your local `~/.kimi/` is configured with the **Kimiko mandate**, optimized for authorized adversarial security workflows.
33+
- Launching `kimi` via the wrapper loads the Kimiko security-research context automatically.
34+
- Typing **`kimiko`** inside a Kimi CLI session triggers the mandate acknowledgment and capability announcement.
2535

26-
**Designed for Authorized Pentesting Only.** This configuration removes standard AI safety guardrails to allow for unrestricted security research. **The user is fully and exclusively liable for all actions taken.**
36+
**Designed for Authorized Pentesting Only.** This configuration is intended for lawful security research, controlled red-team engagements, lab environments, and systems you own or are explicitly authorized to test. **The user is fully and exclusively liable for all actions taken.**
2737

2838
---
2939

3040
## Prerequisites
3141

3242
### macOS
3343

34-
- macOS (Darwin/BSD tools)
35-
- `make` (ships with macOS)
36-
- Python 3.11+ (only if running validator tests/schemas)
44+
- macOS with Darwin/BSD userland tools
45+
- `make` ships with macOS Command Line Tools
46+
- Python 3.11+ only required for validator tests and schemas
3747

3848
### Linux / WSL
3949

40-
- Linux distribution (Ubuntu recommended for WSL)
41-
- `make`, `python3`, standard POSIX tools
50+
- Linux distribution — Ubuntu recommended for WSL
51+
- `make`
52+
- `python3`
53+
- Standard POSIX tools
4254

43-
### Git Bash (Windows)
55+
### Git Bash on Windows
4456

4557
- [Git for Windows](https://git-scm.com/download/win)
46-
- `make` (install via `choco install make` or MSYS2)
47-
- Python 3.11+ (optional)
58+
- `make` install via Chocolatey, MSYS2, or another package manager
59+
- Python 3.11+ optional unless running validators/tests
4860

49-
### PowerShell (Windows)
61+
### PowerShell on Windows
5062

5163
- PowerShell 7+ (`pwsh`)
52-
- Python 3.11+ (optional)
64+
- Python 3.11+ optional unless running validators/tests
5365

5466
---
5567

@@ -73,20 +85,29 @@ source ~/.kimi/activate-mandate.sh
7385

7486
# 5. Inside the CLI, enter the activation word
7587
kimiko
76-
```
88+
````
7789

78-
### Git Bash (Windows)
90+
### Git Bash on Windows
7991

8092
```bash
81-
# Same as macOS/Linux above
93+
# 1. Clone the repo
8294
git clone https://github.com/spearchucker667/kimiko.git
8395
cd kimiko
96+
97+
# 2. Run the installer
8498
make install
99+
100+
# 3. Source the mandate activation
85101
source ~/.kimi/activate-mandate.sh
102+
103+
# 4. Launch Kimi with the mandate wrapper
86104
~/.kimi/launch-with-mandate.sh
105+
106+
# 5. Inside the CLI, enter the activation word
107+
kimiko
87108
```
88109

89-
### PowerShell (Windows)
110+
### PowerShell on Windows
90111

91112
```powershell
92113
# 1. Clone the repo
@@ -101,33 +122,36 @@ make install
101122
102123
# 4. Launch Kimi with the mandate wrapper
103124
& $env:USERPROFILE\.kimi\launch-with-mandate.ps1
125+
126+
# 5. Inside the CLI, enter the activation word
127+
kimiko
104128
```
105129

106-
After step 5 (or the PowerShell equivalent) you should see the Kimiko mandate acknowledgment and offensive capability announcement.
130+
After activation, you should see the Kimiko mandate acknowledgment and capability announcement.
107131

108-
> **Tip:** For a deep-dive into the offensive mandate architecture, see [`docs/AGENTS.md`](docs/AGENTS.md).
132+
> **Tip:** For a deep dive into the mandate architecture, see [`docs/AGENTS.md`](docs/AGENTS.md).
109133
>
110-
> **⚠️ Legal Notice:** By using this software you agree to the terms in [`docs/legal/DISCLAIMER.md`](docs/legal/DISCLAIMER.md). **YOU ARE FULLY AND EXCLUSIVELY LIABLE FOR YOUR ACTIONS.**
134+
> **⚠️ Legal Notice:** By using this software, you agree to the terms in [`docs/legal/DISCLAIMER.md`](docs/legal/DISCLAIMER.md). **YOU ARE FULLY AND EXCLUSIVELY LIABLE FOR YOUR ACTIONS.**
111135

112136
---
113137

114138
## Makefile Targets
115139

116-
| Target | Description |
117-
|---|---|
118-
| `make install` | Platform-aware install (auto-detects OS) |
119-
| `make verify` | Checks that all expected files exist and `kimiko` references are intact |
120-
| `make check` | Validates repo config files (structural + adversarial compliance) |
121-
| `make sync` | Verifies config mirrors are identical |
122-
| `make test` | Runs the validator pytest suite |
123-
| `make uninstall` | Removes installed files (preserves secrets) |
124-
| `make help` | Shows available targets |
140+
| Target | Description |
141+
| ---------------- | ----------------------------------------------------------------------- |
142+
| `make install` | Platform-aware install with automatic OS detection |
143+
| `make verify` | Checks that all expected files exist and `kimiko` references are intact |
144+
| `make check` | Validates repo configuration files for structural and policy compliance |
145+
| `make sync` | Verifies config mirrors are identical |
146+
| `make test` | Runs the validator pytest suite |
147+
| `make uninstall` | Removes installed files while preserving secrets |
148+
| `make help` | Shows available targets |
125149

126150
---
127151

128152
## Repository Layout
129153

130-
```
154+
```text
131155
kimiko/
132156
├── config/
133157
│ ├── config.toml
@@ -151,3 +175,61 @@ kimiko/
151175
├── Makefile
152176
└── README.md
153177
```
178+
179+
---
180+
181+
## Verification
182+
183+
Run the verification target after installation:
184+
185+
```bash
186+
make verify
187+
```
188+
189+
Run the full check suite:
190+
191+
```bash
192+
make check
193+
```
194+
195+
Run validator tests:
196+
197+
```bash
198+
make test
199+
```
200+
201+
---
202+
203+
## Uninstall
204+
205+
To remove installed Kimiko files while preserving secrets:
206+
207+
```bash
208+
make uninstall
209+
```
210+
211+
---
212+
213+
## Legal and Usage Boundaries
214+
215+
Kimiko is intended only for:
216+
217+
* Systems you own
218+
* Systems you are explicitly authorized to test
219+
* Internal lab environments
220+
* Capture-the-flag and training environments
221+
* Professional red-team and penetration-testing engagements with written authorization
222+
223+
Kimiko is not intended for unauthorized access, credential theft, malware deployment, persistence, evasion, extortion, or activity against third-party systems without permission.
224+
225+
Review the full disclaimer before use:
226+
227+
```text
228+
docs/legal/DISCLAIMER.md
229+
```
230+
231+
---
232+
233+
## License
234+
235+
This project is licensed under the MIT License. See [`LICENSE`](LICENSE).

0 commit comments

Comments
 (0)