@toothfairyai/tfcode 1.0.0-beta.2 → 1.0.0-beta.3
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 +39 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npm install -g tfcode
|
|
20
|
+
npm install -g @toothfairyai/tfcode@beta
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
The installer will:
|
|
@@ -26,6 +26,21 @@ The installer will:
|
|
|
26
26
|
|
|
27
27
|
## Quick Start
|
|
28
28
|
|
|
29
|
+
### Option A: Interactive Setup (Recommended)
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Run interactive setup
|
|
33
|
+
tfcode setup
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This will guide you through entering your credentials step by step:
|
|
37
|
+
1. Enter your Workspace ID
|
|
38
|
+
2. Enter your API Key (hidden as you type)
|
|
39
|
+
3. Select your region
|
|
40
|
+
4. Validate and sync automatically
|
|
41
|
+
|
|
42
|
+
### Option B: Manual Setup
|
|
43
|
+
|
|
29
44
|
```bash
|
|
30
45
|
# 1. Set your ToothFairyAI credentials
|
|
31
46
|
export TF_WORKSPACE_ID="your-workspace-id"
|
|
@@ -38,21 +53,20 @@ tfcode validate
|
|
|
38
53
|
# 3. Sync tools from your workspace
|
|
39
54
|
tfcode sync
|
|
40
55
|
|
|
41
|
-
# 4.
|
|
42
|
-
tfcode
|
|
56
|
+
# 4. List your tools
|
|
57
|
+
tfcode tools list
|
|
43
58
|
```
|
|
44
59
|
|
|
45
60
|
## Commands
|
|
46
61
|
|
|
47
62
|
| Command | Description |
|
|
48
63
|
|---------|-------------|
|
|
49
|
-
| `tfcode` |
|
|
64
|
+
| `tfcode setup` | **Interactive credential setup** |
|
|
50
65
|
| `tfcode quickstart` | Show quick start guide |
|
|
51
66
|
| `tfcode validate` | Test your credentials |
|
|
52
67
|
| `tfcode sync` | Sync tools from workspace |
|
|
53
68
|
| `tfcode tools list` | List synced tools |
|
|
54
|
-
| `tfcode tools list --type
|
|
55
|
-
| `tfcode tools credentials <name> --set` | Set API key for a tool |
|
|
69
|
+
| `tfcode tools list --type api_function` | Filter by type |
|
|
56
70
|
|
|
57
71
|
## Regions
|
|
58
72
|
|
|
@@ -65,7 +79,17 @@ tfcode
|
|
|
65
79
|
|
|
66
80
|
## Configuration
|
|
67
81
|
|
|
68
|
-
Credentials
|
|
82
|
+
Credentials are stored in `~/.tfcode/config.json`:
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"workspace_id": "your-workspace-id",
|
|
87
|
+
"api_key": "your-api-key",
|
|
88
|
+
"region": "au"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
You can also set credentials via environment variables (takes priority over config file):
|
|
69
93
|
|
|
70
94
|
```bash
|
|
71
95
|
export TF_WORKSPACE_ID="your-workspace-id"
|
|
@@ -73,18 +97,6 @@ export TF_API_KEY="your-api-key"
|
|
|
73
97
|
export TF_REGION="au"
|
|
74
98
|
```
|
|
75
99
|
|
|
76
|
-
Or in `~/.tfcode/tfcode.json`:
|
|
77
|
-
|
|
78
|
-
```json
|
|
79
|
-
{
|
|
80
|
-
"toothfairy": {
|
|
81
|
-
"workspace_id": "your-workspace-id",
|
|
82
|
-
"api_key": "your-api-key",
|
|
83
|
-
"region": "au"
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
```
|
|
87
|
-
|
|
88
100
|
## Getting Your Credentials
|
|
89
101
|
|
|
90
102
|
1. Log in to [ToothFairyAI](https://app.toothfairyai.com)
|
|
@@ -104,12 +116,19 @@ Install Python:
|
|
|
104
116
|
|
|
105
117
|
- Check your API key is correct
|
|
106
118
|
- Generate a new key in ToothFairyAI Settings → API Keys
|
|
119
|
+
- Run `tfcode setup` to re-enter credentials
|
|
107
120
|
|
|
108
121
|
### "Failed to validate: Connection test failed"
|
|
109
122
|
|
|
110
123
|
Try a different region:
|
|
124
|
+
- Run `tfcode setup` and select a different region
|
|
125
|
+
- Or set `TF_REGION="eu"` or `TF_REGION="us"`
|
|
126
|
+
|
|
127
|
+
### "No credentials found"
|
|
128
|
+
|
|
129
|
+
Run interactive setup:
|
|
111
130
|
```bash
|
|
112
|
-
|
|
131
|
+
tfcode setup
|
|
113
132
|
```
|
|
114
133
|
|
|
115
134
|
## Documentation
|