mirror of
https://gitea.toothfairyai.com/ToothFairyAI/tf_code.git
synced 2026-04-11 19:28:33 +00:00
feat: sync
This commit is contained in:
73
README.md
73
README.md
@@ -290,13 +290,29 @@ tf_code/
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Via curl (recommended)
|
||||
curl -fsSL https://toothfairyai.com/install/tfcode | bash
|
||||
### Requirements
|
||||
|
||||
# Via npm
|
||||
**Python 3.10+ is required** on your machine for ToothFairyAI integration.
|
||||
|
||||
```bash
|
||||
# Check Python version
|
||||
python3 --version # Should be 3.10 or higher
|
||||
|
||||
# Install Python if needed
|
||||
# macOS: brew install python@3.12
|
||||
# Ubuntu: sudo apt-get install python3.12
|
||||
# Windows: Download from https://python.org/downloads
|
||||
```
|
||||
|
||||
### Install tfcode
|
||||
|
||||
```bash
|
||||
# Via npm (recommended)
|
||||
npm install -g tfcode
|
||||
|
||||
# Via curl
|
||||
curl -fsSL https://toothfairyai.com/install/tfcode | bash
|
||||
|
||||
# Via pip
|
||||
pip install tfcode-cli
|
||||
|
||||
@@ -304,6 +320,8 @@ pip install tfcode-cli
|
||||
brew install toothfairyai/tap/tfcode
|
||||
```
|
||||
|
||||
The postinstall script will automatically install the ToothFairyAI Python SDK.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
@@ -383,17 +401,27 @@ tfcode tools test <name> # Test tool call
|
||||
- [x] Document fork management strategy
|
||||
- [x] Push to development branch
|
||||
|
||||
### Phase 2: Tool Sync ⏳ NEXT
|
||||
### Phase 2: Tool Sync ✅ COMPLETE
|
||||
|
||||
**Tasks**:
|
||||
- [ ] Complete tf-sync Python module
|
||||
- [ ] Test tool sync with real TF workspace
|
||||
- [ ] Handle tool metadata caching
|
||||
**Completed**:
|
||||
- [x] Complete tf-sync Python module
|
||||
- [x] Tool sync implementation
|
||||
- [x] Tool metadata caching in tfcode
|
||||
- [x] Implement tfcode CLI commands
|
||||
- [x] `tfcode validate` - credential validation
|
||||
- [x] `tfcode sync` - sync tools from TF workspace
|
||||
- [x] `tfcode tools list` - list synced tools
|
||||
- [x] `tfcode tools list --type mcp|skill|database|function`
|
||||
- [x] `tfcode tools credentials <name> --set/--show`
|
||||
- [x] `tfcode tools debug <name>`
|
||||
- [x] Handle API functions with user credentials
|
||||
- [x] Tool cache persistence (~/.tfcode/tools.json)
|
||||
|
||||
**Pending (Phase 3)**:
|
||||
- [ ] Test tool sync with real TF workspace
|
||||
- [ ] Build tf-mcp-bridge TypeScript module
|
||||
- [ ] Bridge between tf-sync and tfcode core
|
||||
- [ ] MCP proxy client implementation
|
||||
- [ ] Handle API functions with user credentials
|
||||
- [ ] Implement tool refresh/reload
|
||||
- [ ] MCP proxy client implementation
|
||||
- [ ] Tool refresh/reload
|
||||
|
||||
### Phase 3: TF Proxy Integration
|
||||
|
||||
@@ -407,11 +435,14 @@ tfcode tools test <name> # Test tool call
|
||||
|
||||
### Phase 4: CLI & UX
|
||||
|
||||
**Completed**:
|
||||
- [x] Implement tfcode CLI commands
|
||||
- [x] `tfcode validate`
|
||||
- [x] `tfcode sync`
|
||||
- [x] `tfcode tools list`
|
||||
- [x] `tfcode tools credentials`
|
||||
|
||||
**Tasks**:
|
||||
- [ ] Implement tfcode CLI commands
|
||||
- [ ] `tfcode validate`
|
||||
- [ ] `tfcode sync`
|
||||
- [ ] `tfcode tools list`
|
||||
- [ ] Build interactive credential setup
|
||||
- [ ] Add tool status reporting
|
||||
- [ ] Create user-friendly error messages
|
||||
@@ -490,16 +521,16 @@ abdfa7330 feat: initialize tfcode project structure
|
||||
**What's Ready**:
|
||||
- ✅ Clean codebase with minimal branding
|
||||
- ✅ TF SDK integration layer (Python)
|
||||
- ✅ Tool sync module structure
|
||||
- ✅ Tool sync module complete
|
||||
- ✅ CLI commands implemented (`validate`, `sync`, `tools`)
|
||||
- ✅ Multi-region support
|
||||
- ✅ Config schema defined
|
||||
- ✅ Documentation structure
|
||||
|
||||
**What's Next**:
|
||||
- Complete tf-sync Python module
|
||||
- Build tf-mcp-bridge TypeScript module
|
||||
- Test with real TF workspace
|
||||
- Implement CLI commands
|
||||
- Build tf-mcp-bridge TypeScript module
|
||||
- Implement TF Proxy client for tool call routing
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user