Skip to content

Commit 28d35e3

Browse files
committed
docs: rewrite all README files and update package.json metadata
- expand all 6 READMEs with supported tools table, commands table, env var, badges and docs site links - point README language links to localized docs site paths (/fr/, /es/, /pt/) - update package.json description to reflect tool's purpose - update package.json homepage to cli.fishxcode.com
1 parent 9668942 commit 28d35e3

7 files changed

Lines changed: 266 additions & 80 deletions

File tree

README.en.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,61 @@
22

33
[简体中文](./README.zh-CN.md) · [English](./README.en.md) · [Français](./README.fr.md) · [Español](./README.es.md) · [Português](./README.pt.md)
44

5-
Official FishXCode CLI built with Bun + TypeScript.
5+
[![npm version](https://img.shields.io/npm/v/fishxcode-cli)](https://www.npmjs.com/package/fishxcode-cli)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67

7-
## Docs
8+
Official FishXCode CLI — one-click integration with FishXCode API for claude-code, aider, codex, opencode and more.
89

9-
- Quick Start: [docs/en/quick-start.md](./docs/en/quick-start.md)
10-
- Commands: [docs/en/commands.md](./docs/en/commands.md)
11-
- Tool Support: [docs/en/tools.md](./docs/en/tools.md)
12-
- Release & CI: [docs/en/release.md](./docs/en/release.md)
10+
**[📖 Docs](https://cli.fishxcode.com)** · **[🚀 Register](https://fishxcode.com/register?aff=9CTW)** · **[🔑 Get API Key](https://fishxcode.com/console/token)**
1311

1412
## Install
1513

1614
```bash
1715
npm i -g fishxcode-cli
16+
# or run directly without installing
17+
npx fishxcode-cli@latest fishx setup
1818
```
1919

20-
## Usage
20+
## Quick Start
2121

2222
```bash
23-
fishx --help
24-
fishx login
25-
fishx setup
26-
fishx doctor
23+
fishx login # save your FishXCode API Key
24+
fishx setup # configure all AI tools automatically
25+
fishx doctor # verify configuration status
2726
```
2827

29-
## Console
28+
## Supported Tools
3029

31-
- <https://fishxcode.com/console/token>
30+
| Tool | Config File | Auto-configured |
31+
| --- | --- | --- |
32+
| Claude Code | `~/.claude/settings.json` ||
33+
| Codex CLI | `~/.codex/config.toml` ||
34+
| Aider | `~/.aider.conf.yml` ||
35+
| Continue.dev | `~/.continue/config.yaml` ||
36+
| OpenCode | `~/.config/opencode/opencode.json` ||
37+
| OpenClaw | `~/.openclaw/openclaw.json` ||
38+
39+
## Commands
40+
41+
| Command | Description |
42+
| --- | --- |
43+
| `fishx login` | Save FishXCode API Key |
44+
| `fishx logout` | Remove saved credentials |
45+
| `fishx whoami` | Show current API Key (masked) |
46+
| `fishx setup` | Configure all AI tools |
47+
| `fishx doctor` | Check environment and tool status |
48+
| `fishx tools` | List all supported tools |
49+
| `fishx reset` | Reset all tool configurations |
50+
| `fishx balance` | Check account balance *(coming soon)* |
51+
52+
## Environment Variable
53+
54+
```bash
55+
export FISHXCODE_API_KEY=sk-xxx # alternative to fishx login
56+
```
57+
58+
## Links
59+
60+
- **Docs**: <https://cli.fishxcode.com>
61+
- **API Console**: <https://fishxcode.com/console/token>
62+
- **GitHub**: <https://github.com/fishxcode/fishxcode-cli>

README.es.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,61 @@
22

33
[简体中文](./README.zh-CN.md) · [English](./README.en.md) · [Français](./README.fr.md) · [Español](./README.es.md) · [Português](./README.pt.md)
44

5-
CLI oficial de FishXCode con Bun + TypeScript.
5+
[![npm version](https://img.shields.io/npm/v/fishxcode-cli)](https://www.npmjs.com/package/fishxcode-cli)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67

7-
## Documentación
8+
CLI oficial de FishXCode — integración en un clic con la API FishXCode para claude-code, aider, codex, opencode y más.
89

9-
- Inicio rápido: [docs/es/quick-start.md](./docs/es/quick-start.md)
10-
- Comandos: [docs/es/commands.md](./docs/es/commands.md)
11-
- Soporte de herramientas: [docs/es/tools.md](./docs/es/tools.md)
12-
- Release y CI: [docs/es/release.md](./docs/es/release.md)
10+
**[📖 Documentación](https://cli.fishxcode.com/es/)** · **[🚀 Registrarse](https://fishxcode.com/register?aff=9CTW)** · **[🔑 Obtener API Key](https://fishxcode.com/console/token)**
1311

1412
## Instalación
1513

1614
```bash
1715
npm i -g fishxcode-cli
16+
# o ejecutar directamente sin instalar
17+
npx fishxcode-cli@latest fishx setup
1818
```
1919

20-
## Uso
20+
## Inicio rápido
2121

2222
```bash
23-
fishx --help
24-
fishx login
25-
fishx setup
26-
fishx doctor
23+
fishx login # guardar tu API Key de FishXCode
24+
fishx setup # configurar automáticamente todas las herramientas IA
25+
fishx doctor # verificar el estado de la configuración
2726
```
2827

29-
## Consola
28+
## Herramientas soportadas
3029

31-
- <https://fishxcode.com/console/token>
30+
| Herramienta | Archivo de config | Auto-configurado |
31+
| --- | --- | --- |
32+
| Claude Code | `~/.claude/settings.json` ||
33+
| Codex CLI | `~/.codex/config.toml` ||
34+
| Aider | `~/.aider.conf.yml` ||
35+
| Continue.dev | `~/.continue/config.yaml` ||
36+
| OpenCode | `~/.config/opencode/opencode.json` ||
37+
| OpenClaw | `~/.openclaw/openclaw.json` ||
38+
39+
## Comandos
40+
41+
| Comando | Descripción |
42+
| --- | --- |
43+
| `fishx login` | Guardar API Key de FishXCode |
44+
| `fishx logout` | Eliminar credenciales locales |
45+
| `fishx whoami` | Mostrar API Key actual (enmascarada) |
46+
| `fishx setup` | Configurar todas las herramientas IA |
47+
| `fishx doctor` | Verificar entorno y estado de herramientas |
48+
| `fishx tools` | Listar todas las herramientas soportadas |
49+
| `fishx reset` | Restablecer todas las configuraciones |
50+
| `fishx balance` | Consultar saldo de la cuenta *(próximamente)* |
51+
52+
## Variable de entorno
53+
54+
```bash
55+
export FISHXCODE_API_KEY=sk-xxx # alternativa a fishx login
56+
```
57+
58+
## Enlaces
59+
60+
- **Documentación**: <https://cli.fishxcode.com/es/>
61+
- **Consola API**: <https://fishxcode.com/console/token>
62+
- **GitHub**: <https://github.com/fishxcode/fishxcode-cli>

README.fr.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,61 @@
22

33
[简体中文](./README.zh-CN.md) · [English](./README.en.md) · [Français](./README.fr.md) · [Español](./README.es.md) · [Português](./README.pt.md)
44

5-
CLI officiel FishXCode basé sur Bun + TypeScript.
5+
[![npm version](https://img.shields.io/npm/v/fishxcode-cli)](https://www.npmjs.com/package/fishxcode-cli)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67

7-
## Documentation
8+
CLI officiel FishXCode — intégration en un clic avec l'API FishXCode pour claude-code, aider, codex, opencode et plus.
89

9-
- Démarrage rapide : [docs/fr/quick-start.md](./docs/fr/quick-start.md)
10-
- Commandes : [docs/fr/commands.md](./docs/fr/commands.md)
11-
- Outils supportés : [docs/fr/tools.md](./docs/fr/tools.md)
12-
- Release & CI : [docs/fr/release.md](./docs/fr/release.md)
10+
**[📖 Documentation](https://cli.fishxcode.com/fr/)** · **[🚀 S'inscrire](https://fishxcode.com/register?aff=9CTW)** · **[🔑 Obtenir une clé API](https://fishxcode.com/console/token)**
1311

1412
## Installation
1513

1614
```bash
1715
npm i -g fishxcode-cli
16+
# ou exécuter directement sans installation
17+
npx fishxcode-cli@latest fishx setup
1818
```
1919

20-
## Utilisation
20+
## Démarrage rapide
2121

2222
```bash
23-
fishx --help
24-
fishx login
25-
fishx setup
26-
fishx doctor
23+
fishx login # enregistrer votre clé API FishXCode
24+
fishx setup # configurer automatiquement tous les outils IA
25+
fishx doctor # vérifier l'état de la configuration
2726
```
2827

29-
## Console
28+
## Outils supportés
3029

31-
- <https://fishxcode.com/console/token>
30+
| Outil | Fichier de config | Auto-configuré |
31+
| --- | --- | --- |
32+
| Claude Code | `~/.claude/settings.json` ||
33+
| Codex CLI | `~/.codex/config.toml` ||
34+
| Aider | `~/.aider.conf.yml` ||
35+
| Continue.dev | `~/.continue/config.yaml` ||
36+
| OpenCode | `~/.config/opencode/opencode.json` ||
37+
| OpenClaw | `~/.openclaw/openclaw.json` ||
38+
39+
## Commandes
40+
41+
| Commande | Description |
42+
| --- | --- |
43+
| `fishx login` | Enregistrer la clé API FishXCode |
44+
| `fishx logout` | Supprimer les identifiants locaux |
45+
| `fishx whoami` | Afficher la clé API actuelle (masquée) |
46+
| `fishx setup` | Configurer tous les outils IA |
47+
| `fishx doctor` | Vérifier l'environnement et l'état des outils |
48+
| `fishx tools` | Lister tous les outils supportés |
49+
| `fishx reset` | Réinitialiser toutes les configurations |
50+
| `fishx balance` | Consulter le solde du compte *(bientôt disponible)* |
51+
52+
## Variable d'environnement
53+
54+
```bash
55+
export FISHXCODE_API_KEY=sk-xxx # alternative à fishx login
56+
```
57+
58+
## Liens
59+
60+
- **Documentation** : <https://cli.fishxcode.com/fr/>
61+
- **Console API** : <https://fishxcode.com/console/token>
62+
- **GitHub** : <https://github.com/fishxcode/fishxcode-cli>

README.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,61 @@
22

33
[简体中文](./README.zh-CN.md) · [English](./README.en.md) · [Français](./README.fr.md) · [Español](./README.es.md) · [Português](./README.pt.md)
44

5-
FishXCode CLI built with Bun + TypeScript.
5+
[![npm version](https://img.shields.io/npm/v/fishxcode-cli)](https://www.npmjs.com/package/fishxcode-cli)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67

7-
## Quick Links
8+
AI coding tool manager — one-click integration with FishXCode API for claude-code, aider, codex, opencode and more.
89

9-
- Docs (ZH): `docs/zh-CN/`
10-
- Docs (EN): `docs/en/`
11-
- Docs (FR): `docs/fr/`
12-
- Docs (ES): `docs/es/`
13-
- Docs (PT): `docs/pt/`
10+
**[📖 Docs](https://cli.fishxcode.com)** · **[🚀 Register](https://fishxcode.com/register?aff=9CTW)** · **[🔑 Get API Key](https://fishxcode.com/console/token)**
1411

1512
## Install
1613

1714
```bash
1815
npm i -g fishxcode-cli
16+
# or run directly without installing
17+
npx fishxcode-cli@latest fishx setup
1918
```
2019

21-
## Run
20+
## Quick Start
2221

2322
```bash
24-
fishx --help
25-
fishx login
26-
fishx setup
23+
fishx login # save your FishXCode API Key
24+
fishx setup # configure all AI tools automatically
25+
fishx doctor # verify configuration status
2726
```
2827

29-
## API Console
28+
## Supported Tools
3029

31-
- <https://fishxcode.com/console/token>
30+
| Tool | Config File | Auto-configured |
31+
| --- | --- | --- |
32+
| Claude Code | `~/.claude/settings.json` ||
33+
| Codex CLI | `~/.codex/config.toml` ||
34+
| Aider | `~/.aider.conf.yml` ||
35+
| Continue.dev | `~/.continue/config.yaml` ||
36+
| OpenCode | `~/.config/opencode/opencode.json` ||
37+
| OpenClaw | `~/.openclaw/openclaw.json` ||
38+
39+
## Commands
40+
41+
| Command | Description |
42+
| --- | --- |
43+
| `fishx login` | Save FishXCode API Key |
44+
| `fishx logout` | Remove saved credentials |
45+
| `fishx whoami` | Show current API Key (masked) |
46+
| `fishx setup` | Configure all AI tools |
47+
| `fishx doctor` | Check environment and tool status |
48+
| `fishx tools` | List all supported tools |
49+
| `fishx reset` | Reset all tool configurations |
50+
| `fishx balance` | Check account balance *(coming soon)* |
51+
52+
## Environment Variable
53+
54+
```bash
55+
export FISHXCODE_API_KEY=sk-xxx # alternative to fishx login
56+
```
57+
58+
## Links
59+
60+
- **Docs**: <https://cli.fishxcode.com>
61+
- **API Console**: <https://fishxcode.com/console/token>
62+
- **GitHub**: <https://github.com/fishxcode/fishxcode-cli>

README.pt.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,61 @@
22

33
[简体中文](./README.zh-CN.md) · [English](./README.en.md) · [Français](./README.fr.md) · [Español](./README.es.md) · [Português](./README.pt.md)
44

5-
CLI oficial da FishXCode com Bun + TypeScript.
5+
[![npm version](https://img.shields.io/npm/v/fishxcode-cli)](https://www.npmjs.com/package/fishxcode-cli)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67

7-
## Documentação
8+
CLI oficial da FishXCode — integração com um clique na API FishXCode para claude-code, aider, codex, opencode e mais.
89

9-
- Início rápido: [docs/pt/quick-start.md](./docs/pt/quick-start.md)
10-
- Comandos: [docs/pt/commands.md](./docs/pt/commands.md)
11-
- Suporte de ferramentas: [docs/pt/tools.md](./docs/pt/tools.md)
12-
- Release e CI: [docs/pt/release.md](./docs/pt/release.md)
10+
**[📖 Documentação](https://cli.fishxcode.com/pt/)** · **[🚀 Cadastrar](https://fishxcode.com/register?aff=9CTW)** · **[🔑 Obter API Key](https://fishxcode.com/console/token)**
1311

1412
## Instalação
1513

1614
```bash
1715
npm i -g fishxcode-cli
16+
# ou executar diretamente sem instalar
17+
npx fishxcode-cli@latest fishx setup
1818
```
1919

20-
## Uso
20+
## Início rápido
2121

2222
```bash
23-
fishx --help
24-
fishx login
25-
fishx setup
26-
fishx doctor
23+
fishx login # salvar sua API Key da FishXCode
24+
fishx setup # configurar automaticamente todas as ferramentas IA
25+
fishx doctor # verificar o estado da configuração
2726
```
2827

29-
## Console
28+
## Ferramentas suportadas
3029

31-
- <https://fishxcode.com/console/token>
30+
| Ferramenta | Arquivo de config | Auto-configurado |
31+
| --- | --- | --- |
32+
| Claude Code | `~/.claude/settings.json` ||
33+
| Codex CLI | `~/.codex/config.toml` ||
34+
| Aider | `~/.aider.conf.yml` ||
35+
| Continue.dev | `~/.continue/config.yaml` ||
36+
| OpenCode | `~/.config/opencode/opencode.json` ||
37+
| OpenClaw | `~/.openclaw/openclaw.json` ||
38+
39+
## Comandos
40+
41+
| Comando | Descrição |
42+
| --- | --- |
43+
| `fishx login` | Salvar API Key da FishXCode |
44+
| `fishx logout` | Remover credenciais locais |
45+
| `fishx whoami` | Exibir API Key atual (mascarada) |
46+
| `fishx setup` | Configurar todas as ferramentas IA |
47+
| `fishx doctor` | Verificar ambiente e status das ferramentas |
48+
| `fishx tools` | Listar todas as ferramentas suportadas |
49+
| `fishx reset` | Redefinir todas as configurações |
50+
| `fishx balance` | Consultar saldo da conta *(em breve)* |
51+
52+
## Variável de ambiente
53+
54+
```bash
55+
export FISHXCODE_API_KEY=sk-xxx # alternativa ao fishx login
56+
```
57+
58+
## Links
59+
60+
- **Documentação**: <https://cli.fishxcode.com/pt/>
61+
- **Console API**: <https://fishxcode.com/console/token>
62+
- **GitHub**: <https://github.com/fishxcode/fishxcode-cli>

0 commit comments

Comments
 (0)