Ni-l commited on
Commit
8e8e279
Β·
verified Β·
1 Parent(s): 2fd4438

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -70
README.md CHANGED
@@ -1,4 +1,4 @@
1
- YAML
2
  title: Fastep
3
  emoji: πŸš€
4
  colorFrom: indigo
@@ -6,72 +6,5 @@ colorTo: purple
6
  sdk: docker
7
  app_port: 3100
8
  pinned: false
9
- ---
10
-
11
- # Paperclip AI β€” Local Gemini Pro Edition πŸš€
12
-
13
- This is a customized, local deployment of the Paperclip AI multi-agent orchestrator. The core connection layer has been modified via a local `opencode` / `codex` binary interceptor to bypass rigid cloud model UI restrictions and seamlessly route all agent intelligence through Google Gemini Pro's free-tier OpenAI compatibility layer.
14
-
15
- ---
16
-
17
- ## πŸ› οΈ How It Works (Under the Hood)
18
-
19
- Paperclip UI enforces strict default model drop-downs (like `openai/gpt-4`) and expects specific machine-readable tool formatting blocks.
20
-
21
- To bypass this without altering the core TypeScript application logic, this setup utilizes a system-level interceptor script:
22
- 1. **Validation Shaking:** When Paperclip initializes or checks for system connectivity, the script instantly returns `hello` to fulfill verification loops.
23
- 2. **Payload Translation:** When a task is run, the script catches the massive system string, extracts the core textual directives, rewrites it into a standard conversational JSON payload, and routes it directly to Google Gemini's endpoint.
24
- 3. **Graceful Fallbacks:** If API rate limits or connection timeouts occur, the script automatically drops back to a beautifully formatted structural markdown roadmap so your local agents never stall or crash the execution loop.
25
-
26
- ---
27
-
28
- ## πŸ“‹ Environment Configuration
29
-
30
- To run this environment successfully, ensure your Hugging Face Space or Local Environment contains the following variables configured in your variables and secrets manager:
31
-
32
- ### Public Variables
33
- | Variable Name | Value / URL | Purpose |
34
- | :--- | :--- | :--- |
35
- | `OPENAI_BASE_URL` | `https://generativelanguage.googleapis.com/v1beta/openai/` | Redirects standard SDK traffic to Google's compatibility engine |
36
- | `PAPERCLIP_DEFAULT_MODEL`| `gemini-1.5-pro` | Targets the Gemini 1.5 Pro engine profile |
37
- | `TMPDIR` | `/tmp` | Sets fallback storage directory rules |
38
-
39
- ### Protected Secrets
40
- | Secret Name | Value | Purpose |
41
- | :--- | :--- | :--- |
42
- | `OPENAI_API_KEY` | `AIzaSy...` | Your unique Google AI Studio Gemini API Key |
43
-
44
- ---
45
-
46
- ## πŸ‘₯ Managing the Workforce in the UI
47
-
48
- Because the background interceptor overrides incoming configurations globally, follow these exact inputs when building your corporate hierarchy inside the Paperclip dashboard:
49
-
50
- 1. **Adapter Type:** Set explicitly to `opencode`.
51
- 2. **Model String:** Type or paste exactly `openai/gpt-4` (or any string matching the `provider/model` schema).
52
- 3. **Command String:** Leave completely blank.
53
-
54
- Using this method, you can build out your complete virtual workspace architecture:
55
- * **CEO Agent** (Operational coordinator)
56
- * **CTO Agent** (Software architect & systems analyst)
57
- * **Operations Manager** (Task pipeline manager)
58
- * **Product Scout** (Research & market viability)
59
-
60
- ---
61
-
62
- ## πŸ“Š API Usage Reference (Gemini Free Tier)
63
-
64
- Your workspace calls are bound by Google AI Studio's highly sustainable free allowances:
65
- * **Requests Per Minute (RPM):** 2 RPM (Perfect for asynchronous multi-agent step iterations)
66
- * **Requests Per Day (RPD):** 50 RPD (More than enough for running complete, deep daily code sprints)
67
- * **Tokens Per Minute (TPM):** 32,000 TPM
68
-
69
- ---
70
-
71
- ## πŸš€ Launching Your First Sprint
72
-
73
- 1. Navigate to your Paperclip **Board** tab.
74
- 2. Create or open an active task ticket (e.g., `ATIA-4`).
75
- 3. Move the card column status to **In Progress** or **Doing**.
76
- 4. Post your project brief or directive into the ticket comment section.
77
- 5. Click **Run Task** or allow the background heartbeat system to process the update. Watch the live execution stream output your operational assets directly onto your dashboard panels!
 
1
+ ---
2
  title: Fastep
3
  emoji: πŸš€
4
  colorFrom: indigo
 
6
  sdk: docker
7
  app_port: 3100
8
  pinned: false
9
+ license: mit
10
+ ---