@ocis/mycoder-cli-darwin-arm64 3.0.2 → 3.0.4
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 +138 -0
- package/bin/mycoder +0 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# AFS MyCoder CLI
|
|
2
|
+
|
|
3
|
+
The AI coding agent built for the terminal.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@ocis/mycoder-cli)
|
|
6
|
+
|
|
7
|
+
MyCoder is an AI coding agent that runs in your terminal. It reads your
|
|
8
|
+
codebase, answers questions about it, plans changes, and edits files with your
|
|
9
|
+
approval — interactively in a TUI, or as a one-shot command you can script.
|
|
10
|
+
|
|
11
|
+
## Requirements
|
|
12
|
+
|
|
13
|
+
Node.js 20 or later, to install. The CLI itself is a self-contained binary and
|
|
14
|
+
does not run on Node — it is only needed for `npm` and the `postinstall` step
|
|
15
|
+
that links the binary into place.
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @ocis/mycoder-cli
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Verify the install:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
mycoder --version
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Get started
|
|
30
|
+
|
|
31
|
+
Change into the project you want to work on and start MyCoder:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
cd your-project
|
|
35
|
+
mycoder
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
That opens the interactive TUI. From there:
|
|
39
|
+
|
|
40
|
+
- Start a line with `/` to reach the command palette — `/new` starts a fresh
|
|
41
|
+
session, `/editor` composes a long prompt in `$VISUAL` or `$EDITOR`,
|
|
42
|
+
`/skills` lists available skills, `/exit` quits.
|
|
43
|
+
- Type `@` in a prompt to fuzzy-search files in the project and attach them.
|
|
44
|
+
|
|
45
|
+
### Agents
|
|
46
|
+
|
|
47
|
+
Two agents are built in:
|
|
48
|
+
|
|
49
|
+
| Agent | Behavior |
|
|
50
|
+
| ------- | -------------------------------------------------------------------------------------------- |
|
|
51
|
+
| `build` | The default. Executes tools according to your configured permissions. |
|
|
52
|
+
| `plan` | Plan mode. Denies every edit tool except writes to plan files, so it analyzes and proposes. |
|
|
53
|
+
|
|
54
|
+
Pick one with `--agent`, on either the TUI or `mycoder run`:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
mycoder --agent plan
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Use `plan` to explore an unfamiliar codebase or work out an approach, then run
|
|
61
|
+
`build` to carry it out.
|
|
62
|
+
|
|
63
|
+
### One-shot and scripted runs
|
|
64
|
+
|
|
65
|
+
`mycoder run` sends a single message and prints the result, which is what you
|
|
66
|
+
want in scripts and CI:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
mycoder run "explain how authentication works in this project"
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Useful flags:
|
|
73
|
+
|
|
74
|
+
| Flag | Purpose |
|
|
75
|
+
| ------------------ | --------------------------------- |
|
|
76
|
+
| `-c`, `--continue` | Continue the last session |
|
|
77
|
+
| `-s`, `--session` | Continue a specific session id |
|
|
78
|
+
| `-m`, `--model` | Model to use, as `provider/model` |
|
|
79
|
+
|
|
80
|
+
## Commands
|
|
81
|
+
|
|
82
|
+
`mycoder --help` lists everything. The ones you are most likely to reach for:
|
|
83
|
+
|
|
84
|
+
| Command | Purpose |
|
|
85
|
+
| ---------------------------- | ----------------------------------------------- |
|
|
86
|
+
| `mycoder [project]` | Start the interactive TUI (the default command) |
|
|
87
|
+
| `mycoder run [message..]` | Run mycoder with a message |
|
|
88
|
+
| `mycoder models [provider]` | List all available models |
|
|
89
|
+
| `mycoder providers` | Manage AI providers and credentials |
|
|
90
|
+
| `mycoder agent` | Create a new agent |
|
|
91
|
+
| `mycoder session` | Manage sessions |
|
|
92
|
+
| `mycoder export [sessionID]` | Export session data as JSON |
|
|
93
|
+
| `mycoder import <file>` | Import session data from JSON |
|
|
94
|
+
| `mycoder plugin <module>` | Install a plugin and update the config |
|
|
95
|
+
| `mycoder mcp` | Manage MCP (Model Context Protocol) servers |
|
|
96
|
+
| `mycoder stats` | Show token usage statistics |
|
|
97
|
+
| `mycoder upgrade [target]` | Upgrade to the latest or a specific version |
|
|
98
|
+
| `mycoder uninstall` | Uninstall mycoder and remove all related files |
|
|
99
|
+
|
|
100
|
+
Global flags: `--help`/`-h`, `--version`/`-v`, `--print-logs`,
|
|
101
|
+
`--log-level DEBUG|INFO|WARN|ERROR`, and `--pure` to run without external
|
|
102
|
+
plugins. `mycoder completion` generates a shell completion script.
|
|
103
|
+
|
|
104
|
+
## Upgrade
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
npm install -g @ocis/mycoder-cli@latest
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
`mycoder upgrade` does the same from inside an existing install.
|
|
111
|
+
|
|
112
|
+
## Supported platforms
|
|
113
|
+
|
|
114
|
+
The CLI ships as a prebuilt binary per platform. Installing
|
|
115
|
+
`@ocis/mycoder-cli` runs a `postinstall` step that picks the
|
|
116
|
+
`@ocis/mycoder-cli-<os>-<arch>` package matching your machine and links its
|
|
117
|
+
binary into place — always install `@ocis/mycoder-cli`, never a platform
|
|
118
|
+
package directly.
|
|
119
|
+
|
|
120
|
+
| OS | Architectures | Notes |
|
|
121
|
+
| ------- | -------------- | ------------------------------------------ |
|
|
122
|
+
| macOS | `arm64`, `x64` | |
|
|
123
|
+
| Linux | `arm64`, `x64` | glibc and musl (Alpine) are both supported |
|
|
124
|
+
| Windows | `arm64`, `x64` | Native builds, no WSL required |
|
|
125
|
+
|
|
126
|
+
On `x64`, MyCoder uses AVX2 instructions when the CPU reports them and falls
|
|
127
|
+
back to a baseline build when it does not. If the binary installs but exits
|
|
128
|
+
immediately on a virtual machine, the hypervisor is usually masking CPU
|
|
129
|
+
features — set the guest CPU model to `host-passthrough` (libvirt) or `host`
|
|
130
|
+
(Proxmox).
|
|
131
|
+
|
|
132
|
+
## Documentation
|
|
133
|
+
|
|
134
|
+
For more info on how to configure MyCoder, [**head over to our docs**](https://afs-mycoder.twcc.ai/docs/afsmycoder).
|
|
135
|
+
|
|
136
|
+
## License
|
|
137
|
+
|
|
138
|
+
MIT
|
package/bin/mycoder
CHANGED
|
Binary file
|