Skip to content

Commit 41cbb9f

Browse files
author
Tower Test
committed
initial
1 parent dee49ca commit 41cbb9f

1 file changed

Lines changed: 1 addition & 207 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 207 deletions
Original file line numberDiff line numberDiff line change
@@ -1,207 +1 @@
1-
<div align="center">
2-
3-
# <img src="https://raw.githubusercontent.com/PyModel/pythinker-code/main/docs/media/pythinker_animated.svg" alt="Pythinker logo" width="34" align="top"> Pythinker Code
4-
5-
### A coding agent you can run as a desktop app
6-
7-
[![release](https://img.shields.io/github/v/release/PyModel/pythinker-desktop-releases?style=flat-square&label=release&color=4f46e5)](https://github.com/PyModel/pythinker-desktop-releases/releases/latest)
8-
[![Downloads](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PyModel/pythinker-code/badges/downloads-total.json&style=flat&label=Downloads&labelColor=18181b&color=dfb317)](https://code.pythinker.com/)
9-
[![macOS](https://img.shields.io/badge/macOS-e5e7eb?style=flat-square&logo=apple&logoColor=000000)](https://code.pythinker.com/) | [![Windows](https://img.shields.io/badge/Windows-e5e7eb?style=flat-square&logo=data:image/svg%2Bxml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48dGl0bGU+V2luZG93cyAxMTwvdGl0bGU+PHBhdGggZmlsbD0iIzAwNzhENCIgZD0iTTAsMEgxMS4zNzdWMTEuMzcySDBaTTEyLjYyMywwSDI0VjExLjM3MkgxMi42MjNaTTAsMTIuNjIzSDExLjM3N1YyNEgwWm0xMi42MjMsMEgyNFYyNEgxMi42MjMiLz48L3N2Zz4=)](https://code.pythinker.com/)
10-
[![Node.js](https://img.shields.io/badge/Node.js-24.15%2B-339933?style=flat-square&logo=nodedotjs&logoColor=white)](package.json)
11-
[![visitors](https://komarev.com/ghpvc/?username=PyModel-pythinker-code&label=visitors&color=4f46e5&style=flat-square)](https://github.com/PyModel/pythinker-code)
12-
13-
<a href="#get-the-desktop-app">Download</a> &nbsp;·&nbsp;
14-
<a href="#what-the-agent-can-do">Capabilities</a> &nbsp;·&nbsp;
15-
<a href="#in-the-terminal">Terminal</a> &nbsp;·&nbsp;
16-
<a href="#in-your-editor">Editor</a> &nbsp;·&nbsp;
17-
<a href="#development">Development</a>
18-
19-
<br />
20-
21-
<img src="docs/media/desktop-ui.webp" alt="Pythinker Desktop" width="860">
22-
23-
</div>
24-
25-
---
26-
27-
## Get the desktop app
28-
29-
**[Download for macOS or Windows](https://code.pythinker.com/)**
30-
31-
Install it, open it, and describe a task. Pythinker then works on your project the way a colleague would: it reads the code, changes files, runs commands, checks what happened, and keeps going until the job is done.
32-
33-
The app runs the whole agent on your machine. It starts a local host bound to loopback, so nothing is exposed to your network. Closing the window hides the app to the tray instead of killing it, so a long session survives.
34-
35-
If you already use the CLI, the app picks up the same data directory (`~/.pythinker-code/` by default). Your login, providers, MCP servers, and past sessions are already there. Updates install themselves, and Settings has a switch if you would rather they did not.
36-
37-
macOS gets a `.dmg`. Windows gets a per-user installer that does not ask for administrator rights. There is no Linux build yet, so on Linux use the terminal version or run `pythinker web` for the browser interface.
38-
39-
More detail is in the [desktop guide](https://pymodel.github.io/pythinker-code/guides/desktop).
40-
41-
---
42-
43-
## What the agent can do
44-
45-
Everything below behaves the same in the app, in the terminal, and in your editor.
46-
47-
### Work on a real codebase
48-
49-
Pythinker searches and reads your repository, edits files, runs shell commands, and reads the output before it decides what to do next. It runs your tests, reads the failures, and tries again. Ask it to refactor a module, trace a bug, or fill in missing tests, and give it as much rope as you are comfortable with.
50-
51-
### Split work across subagents
52-
53-
Large tasks get delegated. A `coder` subagent makes scoped edits, `explore` maps unfamiliar parts of the repo, and `plan` designs the approach. They run in parallel with their own context, so the main conversation stays readable instead of filling with file dumps.
54-
55-
### Keep control of the tools
56-
57-
You see a tool call before it runs, and you approve it. The permission model lets you pre-approve the boring calls and hold the risky ones. Hooks fire on lifecycle events, so you can block a command, record a decision, or trigger something in your own systems.
58-
59-
### Load your own tools and instructions
60-
61-
`/mcp-config` adds and authenticates [Model Context Protocol](https://modelcontextprotocol.io/) servers from inside a session, over stdio or HTTP, and remembers them for next time. Skills are repo-local instruction files that load on demand with `/skill:<name>`. Plugins bundle skills, servers, and data sources from the marketplace or straight from GitHub.
62-
63-
### Use the model you want
64-
65-
Pythinker models work out of the box. Other providers work by configuration, including any OpenAI-compatible endpoint and local ones.
66-
67-
### Show it instead of describing it
68-
69-
Drop a screen recording into the conversation when the bug is easier to show than to write down.
70-
71-
---
72-
73-
## In the terminal
74-
75-
The CLI ships as a native binary, so there is no Node.js prerequisite.
76-
77-
| Platform | Command |
78-
|---|---|
79-
| macOS / Linux | `curl -fsSL https://code.pythinker.com/pythinker-code/install.sh \| bash` |
80-
| Homebrew | `brew install pymodel/tap/pythinker-code` |
81-
| Windows (PowerShell) | `irm https://code.pythinker.com/pythinker-code/install.ps1 \| iex` |
82-
| Nix | `nix run github:PyModel/pythinker-code` |
83-
| npm | `npm install -g @pymodel/pythinker-code` (needs Node.js 24.15+) |
84-
85-
```sh
86-
cd your-project
87-
pythinker
88-
```
89-
90-
Run `/login` on first launch and pick [OAuth](https://pythinker.com/code) or an [API key](https://pythinker.com/code/console). Then ask for something real:
91-
92-
```text
93-
Find where authentication is handled and add a unit test for the token refresh path.
94-
```
95-
96-
> [!NOTE]
97-
> On Windows, install [Git for Windows](https://gitforwindows.org/) first. Pythinker uses the bundled Git Bash as its shell. To point at a different one, set `PYTHINKER_SHELL_PATH` to the full path of `bash.exe`.
98-
99-
<div align="center">
100-
<img src="https://raw.githubusercontent.com/PyModel/pythinker-code/main/docs/media/terminal-ui.webp" alt="Pythinker Code terminal demo" width="860">
101-
</div>
102-
103-
---
104-
105-
## In your editor
106-
107-
Pythinker speaks the [Agent Client Protocol](https://agentclientprotocol.com/), so Zed, JetBrains, and other ACP editors can host a full session inline. Log in once from the CLI, then point the editor at `pythinker acp`.
108-
109-
<details>
110-
<summary>Zed configuration</summary>
111-
112-
Add to `~/.config/zed/settings.json`:
113-
114-
```json
115-
{
116-
"agent_servers": {
117-
"Pythinker Code": {
118-
"type": "custom",
119-
"command": "pythinker",
120-
"args": ["acp"],
121-
"env": {}
122-
}
123-
}
124-
}
125-
```
126-
127-
</details>
128-
129-
[Using in IDEs](https://pymodel.github.io/pythinker-code/guides/ides) covers JetBrains setup and the capability matrix.
130-
131-
<div align="center">
132-
<img src="https://raw.githubusercontent.com/PyModel/pythinker-code/main/docs/media/acp-integration.gif" alt="ACP IDE integration demo" width="860">
133-
</div>
134-
135-
---
136-
137-
## Documentation
138-
139-
| Topic | Link |
140-
|-------|------|
141-
| Desktop app | [guides/desktop](https://pymodel.github.io/pythinker-code/guides/desktop) |
142-
| Getting started | [guides/getting-started](https://pymodel.github.io/pythinker-code/guides/getting-started) |
143-
| Interaction and approvals | [guides/interaction](https://pymodel.github.io/pythinker-code/guides/interaction) |
144-
| Sessions | [guides/sessions](https://pymodel.github.io/pythinker-code/guides/sessions) |
145-
| Configuration | [configuration/config-files](https://pymodel.github.io/pythinker-code/configuration/config-files) |
146-
| Command reference | [reference/pythinker-command](https://pymodel.github.io/pythinker-code/reference/pythinker-command) |
147-
148-
---
149-
150-
## Development
151-
152-
Pythinker Code is a pnpm monorepo. The desktop app and the CLI both talk to the SDK, never to the engine packages directly.
153-
154-
<p align="center">
155-
<img src="docs/media/Architecture.webp" alt="Pythinker Code architecture" width="836" />
156-
</p>
157-
158-
| Package | Role |
159-
|---------|------|
160-
| `apps/desktop` | macOS and Windows desktop application |
161-
| `apps/pythinker-code` | CLI and terminal UI |
162-
| `apps/pythinker-web` | Browser interface that the desktop app renders |
163-
| `packages/agent-core` | Agent engine: sessions, tools, skills, permissions, plans |
164-
| `packages/kosong` | LLM and provider abstraction |
165-
| `packages/pyaos` | Execution environment, file and process abstractions |
166-
| `packages/server` | REST and WebSocket session host (`/api/v1`) |
167-
| `packages/node-sdk` | Public TypeScript SDK |
168-
169-
Requirements: Node.js 24.15-24.x, pnpm 10.34.3, Git.
170-
171-
```sh
172-
git clone https://github.com/PyModel/pythinker-code.git
173-
cd pythinker-code
174-
pnpm install
175-
176-
pnpm dev:desktop # desktop app in dev mode
177-
pnpm dev:cli # CLI in dev mode
178-
pnpm test # Vitest
179-
pnpm typecheck # TypeScript
180-
pnpm lint # oxlint
181-
pnpm build # build everything
182-
```
183-
184-
---
185-
186-
## Contributing
187-
188-
Bug reports, PRs, plugins, skills, and docs are all welcome. Start with [`CONTRIBUTING.md`](CONTRIBUTING.md), and read [`SECURITY.md`](SECURITY.md) before reporting a vulnerability.
189-
190-
Open an issue before large refactors or API changes. Use Conventional Commits, add a changeset (`pnpm changeset`) when your PR affects a release artifact, and be ready to explain your diff. AI-assisted PRs are held to the same standard as hand-written ones.
191-
192-
---
193-
194-
## License
195-
196-
MIT. See [`LICENSE`](LICENSE).
197-
198-
Our TUI is built on [`pi-tui`](https://github.com/earendil-works/pi-mono/tree/main/packages/tui). Thanks to its authors.
199-
200-
<div align="center">
201-
202-
[code.pythinker.com](https://code.pythinker.com) &nbsp;·&nbsp;
203-
[Download](https://code.pythinker.com/) &nbsp;·&nbsp;
204-
[npm](https://www.npmjs.com/package/@pymodel/pythinker-code) &nbsp;·&nbsp;
205-
[Docs](https://pymodel.github.io/pythinker-code/)
206-
207-
</div>
1+
# fixture

0 commit comments

Comments
 (0)