openxgen 1.3.3 → 1.5.0

package/README.md

@@ -1,107 +1,115 @@
-# OPEN XGEN
+# OPEN XGEN CLI
 
-AI Coding Agent + XGEN Platform CLI.
+A terminal-based AI coding agent and XGEN platform CLI. Chat-first interface inspired by Claude Code — talk to your AI, manage workflows, query knowledge graphs, and handle documents, all from the terminal.
 
-터미널에서 AI 코딩 에이전트, 워크플로우 실행, 문서 관리, 온톨로지 질의. OpenAI/Gemini/Ollama 등 멀티 프로바이더 지원.
-
-## 설치
+## Install
 
 ```bash
 npm install -g openxgen
 ```
 
-> 권한 오류(`EACCES`) 시: `sudo npm install -g openxgen` 또는 [nvm](https://github.com/nvm-sh/nvm) 사용 권장
-
-## 빠른 시작
-
-### AI 에이전트 모드
+## Quick Start
 
 ```bash
-# 프로바이더 설정 (OpenAI, Gemini, Ollama 등)
-xgen provider add
-
-# AI 코딩 에이전트 시작
-xgen agent
-
-# 또는 바로
 xgen
 ```
 
-### XGEN 플랫폼 모드
+That's it. On first run, you'll be guided through provider setup (OpenAI, Gemini, Anthropic, Ollama, etc.).
 
-```bash
-# 서버 연결
-xgen config set-server https://xgen.x2bee.com
-xgen login
-
-# 워크플로우
-xgen wf ls                      # 목록
-xgen wf run <id> "질문"         # 실행
-xgen chat                       # 대화 모드
-
-# 문서
-xgen doc ls                     # 목록
-xgen doc upload <file>          # 업로드
-
-# 온톨로지
-xgen ont query "질문"           # GraphRAG 질의
-xgen ont chat                   # 멀티턴 대화
+## What It Does
+
+```
+❯ show workflows          → lists all XGEN workflows
+❯ run #6 "hello"          → executes workflow immediately
+❯ collections             → shows document collections
+❯ list files in ./src     → browses local filesystem
+❯ read main.py            → displays file contents
+❯ write a fibonacci func  → generates code + saves file
+❯ run npm test            → executes shell command
 ```
 
-## 커맨드
+No menus, no wizards. Just tell it what you want.
 
-| 커맨드 | 설명 |
-|--------|------|
-| `xgen` | 에이전트 또는 채팅 모드 (설정에 따라) |
-| `xgen agent` | AI 코딩 에이전트 |
-| `xgen provider add/ls/use/remove` | 프로바이더 관리 |
-| `xgen chat [id]` | 워크플로우 대화 |
-| `xgen wf ls/info/run/history` | 워크플로우 관리 |
-| `xgen doc ls/upload/info` | 문서 관리 |
-| `xgen ont query/chat/stats` | 온톨로지 질의 |
-| `xgen config` | 설정 관리 |
-| `xgen login/logout/whoami` | 인증 |
+## Features
 
-## AI 에이전트 도구
+### AI Agent
+- **9 providers**: OpenAI, Gemini, Anthropic, Ollama, Groq, Together AI, OpenRouter, DeepSeek, Custom (OpenAI-compatible)
+- **50+ models** with auto-detection from environment variables
+- **Streaming** responses with multi-step tool calling (up to 20 rounds)
+- **Token usage** tracking per response and per session
 
-에이전트 모드에서 AI가 사용할 수 있는 도구:
+### Built-in Tools (7)
+`file_read` `file_write` `file_edit` `bash` `grep` `list_files` `sandbox_run`
 
-- **file_read** — 파일 읽기
-- **file_write** — 파일 생성/덮어쓰기
-- **file_edit** — 파일 내 텍스트 교체
-- **bash** — 셸 명령어 실행
-- **grep** — 파일 내 패턴 검색
-- **list_files** — 디렉토리 목록 / glob 검색
+### XGEN Platform Tools (10)
+`xgen_workflow_list` `xgen_workflow_run` `xgen_workflow_info` `xgen_collection_list` `xgen_document_list` `xgen_document_upload` `xgen_graph_rag_query` `xgen_graph_stats` `xgen_execution_history` `xgen_server_status`
 
-## 프로바이더 지원
+### MCP Integration
+Reads `.mcp.json` and auto-connects to MCP servers (stdio transport).
 
-| 프로바이더 | 타입 | 비고 |
-|-----------|------|------|
-| OpenAI | `openai` | GPT-4o, GPT-4o-mini 등 |
-| Google Gemini | `gemini` | OpenAI 호환 엔드포인트 사용 |
-| Ollama | `ollama` | 로컬 모델 (API Key 불필요) |
-| Anthropic | `anthropic` | Claude 모델 |
-| Custom | `custom` | OpenAI 호환 API 서버 |
+### Conversation History
+Save and restore chat sessions. Auto-stored in `~/.xgen/conversations/`.
 
-## 설정 파일
+### TUI Dashboard
+4-panel blessed-based dashboard: workflows | details | collections | AI chat.
+
+## Slash Commands
+
+| Command | Description |
+|---------|-------------|
+| `/connect` | Connect to XGEN server (HQ / Jeju / Lotte presets) |
+| `/env` | Switch environment |
+| `/provider` | Change AI provider |
+| `/dashboard` | Open TUI dashboard |
+| `/tools` | List available tools |
+| `/status` | Show connection status |
+| `/save [name]` | Save conversation |
+| `/load` | Load previous conversation |
+| `/conversations` | List saved conversations |
+| `/usage` | Show token usage |
+| `/clear` | Reset conversation |
+| `/exit` | Quit |
+
+## Providers
+
+| Provider | Models |
+|----------|--------|
+| OpenAI | gpt-4o, gpt-4.1, gpt-4o-mini, o3-mini |
+| Google Gemini | gemini-2.5-pro, gemini-2.0-flash |
+| Anthropic | claude-opus-4, claude-sonnet-4 |
+| Ollama | llama3.1, codellama, qwen2.5-coder |
+| Groq | llama-3.3-70b, mixtral-8x7b |
+| Together AI | Meta-Llama-3.1-70B |
+| OpenRouter | multi-model proxy |
+| DeepSeek | deepseek-chat, deepseek-coder |
+| Custom | any OpenAI-compatible endpoint |
+
+## Config
 
 ```
 ~/.xgen/
-├── config.json      # 서버 URL, 테마 등
-├── auth.json        # XGEN 로그인 토큰
-└── providers.json   # AI 프로바이더 설정
+├── config.json          server URL, defaults
+├── auth.json            login tokens
+├── providers.json       AI providers
+├── environments.json    server profiles
+└── conversations/       saved chat sessions
 ```
 
-## 개발
+## Development
 
 ```bash
-git clone <repo>
-cd xgen-cli
+git clone https://github.com/jinsoo96/openxgen.git
+cd openxgen
 npm install
 npm run build
-npm run dev     # watch 모드
+npm run dev     # watch mode
 ```
 
+## Links
+
+- npm: https://www.npmjs.com/package/openxgen
+- GitHub: https://github.com/jinsoo96/openxgen
+
 ## License
 
 MIT