fifony 0.1.11
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/FIFONY.md +173 -0
- package/LICENSE +201 -0
- package/NOTICE +23 -0
- package/README.md +175 -0
- package/app/dist/assets/index-BE3a-eEo.js +13 -0
- package/app/dist/icon-maskable.svg +8 -0
- package/app/dist/icon.svg +7 -0
- package/app/dist/index.html +24 -0
- package/app/dist/manifest.webmanifest +49 -0
- package/app/dist/offline.html +86 -0
- package/app/dist/service-worker.js +100 -0
- package/app/public/icon-maskable.svg +8 -0
- package/app/public/icon.svg +7 -0
- package/app/public/manifest.webmanifest +49 -0
- package/app/public/offline.html +86 -0
- package/app/public/service-worker.js +100 -0
- package/bin/fifony.js +54 -0
- package/dist/chunk-LH5V2WV2.js +389 -0
- package/dist/chunk-LH5V2WV2.js.map +1 -0
- package/dist/cli.js +204 -0
- package/dist/cli.js.map +1 -0
- package/dist/mcp/server.js +747 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/runtime/run-local.js +6569 -0
- package/dist/runtime/run-local.js.map +1 -0
- package/package.json +69 -0
- package/src/fixtures/agent-catalog.json +208 -0
- package/src/fixtures/skill-catalog.json +67 -0
package/FIFONY.md
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# Fifony local runtime reference
|
|
2
|
+
|
|
3
|
+
This repository runs Fifony as a pure TypeScript local orchestrator with no external tracker dependency.
|
|
4
|
+
|
|
5
|
+
## What this package provides
|
|
6
|
+
|
|
7
|
+
- Filesystem-backed orchestration through the local persistence runtime.
|
|
8
|
+
- Durable tracker state that can also start empty and accept work over HTTP.
|
|
9
|
+
- Local workspace snapshots for reproducible execution.
|
|
10
|
+
- Queue runner with concurrency, retries, retry backoff, and stale-run recovery.
|
|
11
|
+
- Local event log, API, and dashboard through the `s3db.js` `ApiPlugin`.
|
|
12
|
+
- Multi-agent pipelines with `codex` and `claude`.
|
|
13
|
+
|
|
14
|
+
## Relevant files
|
|
15
|
+
|
|
16
|
+
- Workflow template: [WORKFLOW.md](./WORKFLOW.md)
|
|
17
|
+
- Published entrypoint: [bin/fifony.js](./bin/fifony.js)
|
|
18
|
+
- CLI router: [src/cli.ts](./src/cli.ts)
|
|
19
|
+
- Runtime engine: [src/runtime/run-local.ts](./src/runtime/run-local.ts)
|
|
20
|
+
- Dashboard: [app/index.html](./app/index.html)
|
|
21
|
+
|
|
22
|
+
## Environment variables
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
export FIFONY_TRACKER_KIND=filesystem
|
|
26
|
+
export FIFONY_WORKSPACE_ROOT=$PWD
|
|
27
|
+
export FIFONY_PERSISTENCE=$PWD
|
|
28
|
+
export FIFONY_AGENT_COMMAND='codex run --json "$FIFONY_ISSUE_JSON"'
|
|
29
|
+
export FIFONY_AGENT_PROVIDER=codex
|
|
30
|
+
export FIFONY_WORKER_CONCURRENCY=2
|
|
31
|
+
export FIFONY_MAX_ATTEMPTS=3
|
|
32
|
+
export FIFONY_AGENT_MAX_TURNS=4
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`FIFONY_AGENT_COMMAND` is required unless `WORKFLOW.md` provides `codex.command` or `claude.command`.
|
|
36
|
+
|
|
37
|
+
Node requirement:
|
|
38
|
+
|
|
39
|
+
- Node.js 23 or newer
|
|
40
|
+
|
|
41
|
+
## Start examples
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx fifony
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Default state location:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
./.fifony/
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Override the persistence root:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx fifony --persistence /path/to/root
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Run the MCP server:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx fifony mcp
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Run a single cycle:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npx fifony --once
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Run with the API and dashboard:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npx fifony --port 4040 --concurrency 2 --attempts 3
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Runtime behavior
|
|
78
|
+
|
|
79
|
+
- Local bootstrap creates a source snapshot under `./.fifony/source`.
|
|
80
|
+
- Workflow is rendered to `./.fifony/WORKFLOW.local.md`.
|
|
81
|
+
- Runtime state is stored under `./.fifony/s3db/` by the `s3db.js` `FileSystemClient`.
|
|
82
|
+
- Event log is stored in `./.fifony/fifony-local.log`.
|
|
83
|
+
- `WORKFLOW.md` front matter and Markdown body define the execution contract when present.
|
|
84
|
+
- `hooks.after_create` runs once for a new issue workspace; otherwise the runtime copies the local source snapshot.
|
|
85
|
+
- `hooks.before_run` and `hooks.after_run` can wrap each agent turn.
|
|
86
|
+
- `agent.provider` can be `codex` or `claude`.
|
|
87
|
+
- `agent.providers[]` can mix both in one pipeline.
|
|
88
|
+
- `agent.profile` resolves to local profile files from workspace or home directories.
|
|
89
|
+
- `routing.enabled` can disable automatic task routing.
|
|
90
|
+
- `routing.priorities` can override the default scheduler order by capability category.
|
|
91
|
+
- `routing.overrides[]` can override the automatic provider/profile selection for matching tasks.
|
|
92
|
+
- `routing.overrides[].match.paths` can force routing based on target directories or files.
|
|
93
|
+
- Issue payloads can carry `paths[]` so routing can use the real change surface, not only text and labels.
|
|
94
|
+
- When `paths[]` is omitted, Fifony infers routing hints from path-like text mentions and from files changed inside an existing persisted workspace.
|
|
95
|
+
- Fifony derives labels like `capability:<category>` and `overlay:<name>` from the routing result for queue triage and visibility.
|
|
96
|
+
- The rendered prompt is written to `fifony-prompt.md` and exported through `FIFONY_PROMPT` and `FIFONY_PROMPT_FILE`.
|
|
97
|
+
- Each issue runs as a multi-turn session controlled by `agent.max_turns`.
|
|
98
|
+
- Each turn exports `FIFONY_AGENT_PROVIDER`, `FIFONY_AGENT_ROLE`, `FIFONY_AGENT_PROFILE`, `FIFONY_AGENT_PROFILE_FILE`, `FIFONY_AGENT_PROFILE_INSTRUCTIONS`, `FIFONY_SESSION_ID`, `FIFONY_SESSION_KEY`, `FIFONY_TURN_INDEX`, `FIFONY_MAX_TURNS`, `FIFONY_TURN_PROMPT`, `FIFONY_TURN_PROMPT_FILE`, `FIFONY_PREVIOUS_OUTPUT`, and `FIFONY_RESULT_FILE`.
|
|
99
|
+
- The agent can continue, finish, block, or fail by printing `FIFONY_STATUS=...` or by writing `fifony-result.json`.
|
|
100
|
+
- Session and pipeline state are persisted in `s3db`.
|
|
101
|
+
- Workspace JSON artifacts are temporary CLI handoff files, not the source of truth.
|
|
102
|
+
- The `s3db` resources are partitioned for the main operational lookups (`state`, `capabilityCategory`, `issueId`, `kind`, `attempt`, `provider/role`).
|
|
103
|
+
- The scheduler advances one turn per execution slot and resumes persisted `In Progress` work.
|
|
104
|
+
- When issue priority ties, the scheduler prefers more critical capability categories first (`security`, `bugfix`, `backend`, `devops`, `frontend-ui`, `architecture`, `documentation`, `default`) unless `routing.priorities` overrides that order.
|
|
105
|
+
- `npx fifony mcp` keeps the scheduler alive even without the dashboard port.
|
|
106
|
+
- `npx fifony mcp` starts a stdio MCP server backed by the same durable `s3db` state as the runtime.
|
|
107
|
+
- frontend-heavy tasks automatically carry stricter review overlays such as `impeccable` when matched by the capability resolver.
|
|
108
|
+
|
|
109
|
+
## MCP capabilities
|
|
110
|
+
|
|
111
|
+
Resources:
|
|
112
|
+
|
|
113
|
+
- `fifony://guide/overview`
|
|
114
|
+
- `fifony://guide/runtime`
|
|
115
|
+
- `fifony://guide/integration`
|
|
116
|
+
- `fifony://state/summary`
|
|
117
|
+
- `fifony://issues`
|
|
118
|
+
- `fifony://workspace/workflow`
|
|
119
|
+
- `fifony://issue/<id>`
|
|
120
|
+
|
|
121
|
+
Tools:
|
|
122
|
+
|
|
123
|
+
- `fifony.status`
|
|
124
|
+
- `fifony.list_issues`
|
|
125
|
+
- `fifony.create_issue`
|
|
126
|
+
- `fifony.update_issue_state`
|
|
127
|
+
- `fifony.integration_config`
|
|
128
|
+
|
|
129
|
+
Prompts:
|
|
130
|
+
|
|
131
|
+
- `fifony-integrate-client`
|
|
132
|
+
- `fifony-plan-issue`
|
|
133
|
+
- `fifony-review-workflow`
|
|
134
|
+
|
|
135
|
+
Recommended MCP client config:
|
|
136
|
+
|
|
137
|
+
```json
|
|
138
|
+
{
|
|
139
|
+
"mcpServers": {
|
|
140
|
+
"fifony": {
|
|
141
|
+
"command": "npx",
|
|
142
|
+
"args": ["fifony", "mcp", "--workspace", "/path/to/workspace", "--persistence", "/path/to/workspace"]
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## HTTP surface
|
|
149
|
+
|
|
150
|
+
HTTP surface:
|
|
151
|
+
|
|
152
|
+
- `GET /state` — runtime snapshot with capability counts
|
|
153
|
+
- `GET /status` — health check
|
|
154
|
+
- `GET /events/feed` with optional `issueId`, `kind`, and `since` query filters
|
|
155
|
+
- `GET /issues/:id/pipeline` — pipeline snapshot for one issue
|
|
156
|
+
- `GET /issues/:id/sessions` — session history for one issue
|
|
157
|
+
- `POST /issues/:id/state` — transition issue state
|
|
158
|
+
- `POST /issues/:id/retry` — retry issue
|
|
159
|
+
- `POST /issues/:id/cancel` — cancel issue
|
|
160
|
+
- `POST /issues/create` — create issue
|
|
161
|
+
- `GET /providers` — detected providers with availability
|
|
162
|
+
- `GET /parallelism` — parallelism analysis
|
|
163
|
+
- `POST /config/concurrency` — set worker concurrency
|
|
164
|
+
- `POST /refresh` — request manual refresh event
|
|
165
|
+
|
|
166
|
+
Generated documentation and native resources:
|
|
167
|
+
|
|
168
|
+
- `/docs`
|
|
169
|
+
- `/runtime_state`
|
|
170
|
+
- `/issues`
|
|
171
|
+
- `/events`
|
|
172
|
+
- `/agent_sessions`
|
|
173
|
+
- `/agent_pipelines`
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
Copyright 2025 OpenAI
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
Fifony — https://github.com/forattini-dev/fifony
|
|
18
|
+
Copyright 2025-2026 Filipe Forattini
|
|
19
|
+
|
|
20
|
+
This project is a fork of OpenAI Codex CLI (https://github.com/openai/codex)
|
|
21
|
+
with substantial modifications including: multi-provider agent orchestration,
|
|
22
|
+
dashboard UI, issue lifecycle management, capability routing, onboarding wizard,
|
|
23
|
+
and project scanning system.
|
package/README.md
ADDED
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# 🎻 Fifony
|
|
4
|
+
|
|
5
|
+
### AI agents that actually ship code. You just watch.
|
|
6
|
+
|
|
7
|
+
Point at a repo. Open the dashboard. AI plans, builds, and reviews — you approve.
|
|
8
|
+
|
|
9
|
+
One command. Full orchestra.
|
|
10
|
+
|
|
11
|
+
> Local-first runtime. Browser dashboard. MCP server. All batteries included.
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx -y fifony --port 4040
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Done. Open **http://localhost:4040** — you have a full dashboard.
|
|
24
|
+
|
|
25
|
+
Current directory = workspace. State lives in `.fifony/`. No setup, no config, no accounts.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## How It Works
|
|
30
|
+
|
|
31
|
+
### 1. Create an Issue
|
|
32
|
+
Open the dashboard, click "+", type what you want done. The issue starts in **Planning**.
|
|
33
|
+
|
|
34
|
+
### 2. AI Plans It
|
|
35
|
+
Click "Generate Plan" — an AI analyzes your codebase and creates a structured execution plan with steps, risks, file paths, complexity estimate, and tooling decisions.
|
|
36
|
+
|
|
37
|
+
### 3. You Approve
|
|
38
|
+
Review the plan. Approve it → the issue moves to **Todo** and agents pick it up automatically.
|
|
39
|
+
|
|
40
|
+
### 4. Agents Execute
|
|
41
|
+
The configured executor agent (Claude or Codex) implements the changes in an isolated workspace. You can watch live output in the Agents tab.
|
|
42
|
+
|
|
43
|
+
### 5. Automated Review
|
|
44
|
+
A reviewer agent inspects the diff and either approves (→ Done), requests rework (→ back to execution), or blocks for human intervention.
|
|
45
|
+
|
|
46
|
+
### 6. You Ship
|
|
47
|
+
Review the diff in the dashboard, merge the changes.
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
Planning → Todo → Queued → Running → In Review → Done
|
|
51
|
+
↑ ↓
|
|
52
|
+
└──── Blocked ←── Rework ──────────────┘
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Dashboard
|
|
58
|
+
|
|
59
|
+
Start with `--port` and get a full browser UI:
|
|
60
|
+
|
|
61
|
+
| Page | What you see |
|
|
62
|
+
|------|-------------|
|
|
63
|
+
| **Kanban** | Issues flowing through the pipeline. Stats bar with token usage sparkline. |
|
|
64
|
+
| **Issues** | Searchable grid with engineering metrics: cycle time, lead time, tokens, cost, diff stats. |
|
|
65
|
+
| **Agents** | Live cockpit: active worker slots with real-time output, queue, recently completed. |
|
|
66
|
+
| **Settings** | Workflow config (provider + model + effort per stage), theme, notifications, providers. |
|
|
67
|
+
|
|
68
|
+
### Workflow Configuration
|
|
69
|
+
|
|
70
|
+
In **Settings → Workflow**, configure what runs at each pipeline stage:
|
|
71
|
+
|
|
72
|
+
| Stage | Default | What it does |
|
|
73
|
+
|-------|---------|-------------|
|
|
74
|
+
| **Plan** | Claude Sonnet (high effort) | Generates structured execution plan |
|
|
75
|
+
| **Execute** | Codex (medium effort) | Implements the code changes |
|
|
76
|
+
| **Review** | Claude Sonnet (medium effort) | Reviews the diff and decides pass/rework |
|
|
77
|
+
|
|
78
|
+
Each stage lets you pick: **provider** (Claude or Codex), **model**, and **reasoning effort** (low → extra-high).
|
|
79
|
+
|
|
80
|
+
### PWA
|
|
81
|
+
|
|
82
|
+
Install it as a desktop app. Works offline. Desktop notifications when issues change state.
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## MCP Server
|
|
87
|
+
|
|
88
|
+
Turn Fifony into tools for your editor:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
npx -y fifony mcp
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"mcpServers": {
|
|
97
|
+
"fifony": {
|
|
98
|
+
"command": "npx",
|
|
99
|
+
"args": ["-y", "fifony", "mcp", "--workspace", "/path/to/repo"]
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Create issues, check status, review workflows — all without leaving the editor.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## API
|
|
110
|
+
|
|
111
|
+
Full REST + WebSocket API with auto-generated OpenAPI docs:
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
http://localhost:4040/docs
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Key endpoints:
|
|
118
|
+
|
|
119
|
+
| Endpoint | Description |
|
|
120
|
+
|----------|-------------|
|
|
121
|
+
| `GET /api/state` | Full runtime state with issues, metrics, config |
|
|
122
|
+
| `POST /api/issues/create` | Create a new issue |
|
|
123
|
+
| `POST /api/issues/:id/plan` | Generate AI plan for an issue |
|
|
124
|
+
| `POST /api/issues/:id/approve` | Approve plan and start execution |
|
|
125
|
+
| `GET /api/live/:id` | Live agent output (PID, log tail, elapsed) |
|
|
126
|
+
| `GET /api/diff/:id` | Git diff of workspace changes |
|
|
127
|
+
| `GET /api/config/workflow` | Get/set pipeline workflow config |
|
|
128
|
+
| `GET /api/analytics/tokens` | Token usage analytics |
|
|
129
|
+
| `/ws` | WebSocket for real-time state updates |
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Run Modes
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# Full experience — dashboard + API + scheduler
|
|
137
|
+
npx -y fifony --port 4040
|
|
138
|
+
|
|
139
|
+
# Dev mode — Vite HMR on port+1
|
|
140
|
+
npx -y fifony --port 4040 --dev
|
|
141
|
+
|
|
142
|
+
# Headless — just the scheduler, no UI
|
|
143
|
+
npx -y fifony
|
|
144
|
+
|
|
145
|
+
# MCP server — stdio for editor integration
|
|
146
|
+
npx -y fifony mcp
|
|
147
|
+
|
|
148
|
+
# Custom workspace
|
|
149
|
+
npx -y fifony --workspace /path/to/repo --port 4040
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## Architecture
|
|
155
|
+
|
|
156
|
+
```
|
|
157
|
+
.fifony/ ← all state lives here (gitignore it)
|
|
158
|
+
s3db/ ← durable database (issues, events, sessions, settings)
|
|
159
|
+
source/ ← snapshot of your codebase
|
|
160
|
+
workspaces/ ← one per issue (isolated agent workspace)
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
**Persistence**: [s3db.js](https://github.com/forattini-dev/s3db.js) with FileSystemClient. Issues, events, settings, agent sessions — all persisted and recoverable.
|
|
164
|
+
|
|
165
|
+
**State Machine**: `Planning → Todo → Queued → Running → Interrupted → In Review → Blocked → Done → Cancelled`
|
|
166
|
+
|
|
167
|
+
**Agent Protection**: Detached child processes survive server restarts. PID tracking for recovery. Graceful shutdown marks running issues as Interrupted.
|
|
168
|
+
|
|
169
|
+
**Token Analytics**: EventualConsistency plugin tracks token usage per model with daily/weekly rollups.
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## License
|
|
174
|
+
|
|
175
|
+
MIT
|