@straiffi/archon 1.0.6 → 1.0.8
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/LICENSE +114 -0
- package/README.md +20 -16
- package/package.json +4 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
Archon Package License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Juuso Soikkeli. All rights reserved.
|
|
4
|
+
|
|
5
|
+
This Archon Package License (the "License") governs copies of the Archon software
|
|
6
|
+
that are distributed by Juuso Soikkeli through the npm package `@straiffi/archon` or
|
|
7
|
+
through another distribution channel expressly authorized by Juuso Soikkeli.
|
|
8
|
+
|
|
9
|
+
By downloading, installing, copying, or using the Software, you agree to this
|
|
10
|
+
License.
|
|
11
|
+
|
|
12
|
+
1. Definitions
|
|
13
|
+
|
|
14
|
+
"Licensor" means Straiffi.
|
|
15
|
+
|
|
16
|
+
"Software" means the Archon software distributed under this License, including
|
|
17
|
+
the package contents, bundled assets, and accompanying documentation included in
|
|
18
|
+
that distribution.
|
|
19
|
+
|
|
20
|
+
"You" means the individual or legal entity exercising rights under this
|
|
21
|
+
License.
|
|
22
|
+
|
|
23
|
+
2. License Grant
|
|
24
|
+
|
|
25
|
+
Subject to your compliance with this License, Licensor grants you a limited,
|
|
26
|
+
non-exclusive, non-transferable, non-sublicensable license to:
|
|
27
|
+
|
|
28
|
+
- download, install, run, and use the Software for any lawful purpose, whether
|
|
29
|
+
commercial or non-commercial;
|
|
30
|
+
- make copies of the Software solely as reasonably necessary for your permitted
|
|
31
|
+
use, including for backup, internal deployment, CI/CD, and internal artifact
|
|
32
|
+
caching; and
|
|
33
|
+
- modify the Software and use those modified copies privately for your own use,
|
|
34
|
+
provided you do not distribute, publish, host, or otherwise make those
|
|
35
|
+
modified copies available to any third party.
|
|
36
|
+
|
|
37
|
+
3. Restrictions
|
|
38
|
+
|
|
39
|
+
You may not, and may not permit any third party to:
|
|
40
|
+
|
|
41
|
+
- distribute, publish, transfer, assign, sublicense, sell, resell, rent,
|
|
42
|
+
lease, or otherwise make the Software available to any third party;
|
|
43
|
+
- republish the Software to npm or any other package registry, mirror, or
|
|
44
|
+
public distribution channel;
|
|
45
|
+
- provide, host, operate, or make the Software available as a managed service,
|
|
46
|
+
software-as-a-service, platform service, or similar offering for the benefit
|
|
47
|
+
of any third party;
|
|
48
|
+
- market, offer, or provide the Software under a different brand, white-label
|
|
49
|
+
offering, OEM arrangement, or similar commercial arrangement;
|
|
50
|
+
- distribute, publish, transfer, or otherwise make available any modified
|
|
51
|
+
version of the Software or any derivative work based on the Software;
|
|
52
|
+
- remove or obscure any copyright, trademark, or other proprietary notice
|
|
53
|
+
included in the Software; or
|
|
54
|
+
- use the Software in violation of applicable law.
|
|
55
|
+
|
|
56
|
+
4. Ownership; No Source Repository Rights
|
|
57
|
+
|
|
58
|
+
The Software is licensed, not sold. As between you and Licensor, Licensor and
|
|
59
|
+
its licensors retain all right, title, and interest in and to the Software,
|
|
60
|
+
including all intellectual property rights.
|
|
61
|
+
|
|
62
|
+
This License grants no right to access, receive, or use any private source code
|
|
63
|
+
repository, unpublished source code, build pipeline, or other non-public
|
|
64
|
+
materials related to the Software.
|
|
65
|
+
|
|
66
|
+
No trademark, trade name, logo, or brand rights are granted except as necessary
|
|
67
|
+
to identify the Software as distributed by Licensor.
|
|
68
|
+
|
|
69
|
+
5. Third-Party Software
|
|
70
|
+
|
|
71
|
+
The Software may include or depend on third-party components that are licensed
|
|
72
|
+
under separate open-source or third-party license terms. Those components are
|
|
73
|
+
licensed to you under their respective terms, not this License.
|
|
74
|
+
|
|
75
|
+
6. Future Versions
|
|
76
|
+
|
|
77
|
+
This License applies only to the specific versions of the Software distributed
|
|
78
|
+
under these terms. Licensor may release future versions of the Software under
|
|
79
|
+
different terms, including paid, commercial, proprietary, or open-source terms.
|
|
80
|
+
|
|
81
|
+
7. Termination
|
|
82
|
+
|
|
83
|
+
This License terminates automatically if you fail to comply with any of its
|
|
84
|
+
terms. Upon termination, you must stop using the Software and delete all copies
|
|
85
|
+
of it in your possession or control, except to the extent applicable law
|
|
86
|
+
requires otherwise.
|
|
87
|
+
|
|
88
|
+
8. Disclaimer of Warranties
|
|
89
|
+
|
|
90
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE," WITHOUT WARRANTY OF ANY
|
|
91
|
+
KIND, EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
|
|
92
|
+
FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. LICENSOR DOES
|
|
93
|
+
NOT WARRANT THAT THE SOFTWARE WILL BE UNINTERRUPTED, ERROR-FREE, OR MEET YOUR
|
|
94
|
+
REQUIREMENTS.
|
|
95
|
+
|
|
96
|
+
9. Limitation of Liability
|
|
97
|
+
|
|
98
|
+
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR OR
|
|
99
|
+
ITS LICENSORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL,
|
|
100
|
+
EXEMPLARY, OR PUNITIVE DAMAGES, OR FOR ANY LOSS OF PROFITS, REVENUE, DATA,
|
|
101
|
+
GOODWILL, OR BUSINESS INTERRUPTION, ARISING OUT OF OR RELATED TO THE SOFTWARE
|
|
102
|
+
OR THIS LICENSE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
103
|
+
|
|
104
|
+
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE TOTAL LIABILITY OF
|
|
105
|
+
LICENSOR AND ITS LICENSORS FOR ALL CLAIMS ARISING OUT OF OR RELATING TO THE
|
|
106
|
+
SOFTWARE OR THIS LICENSE WILL NOT EXCEED THE AMOUNT YOU PAID LICENSOR FOR THE
|
|
107
|
+
SOFTWARE IN THE TWELVE (12) MONTHS BEFORE THE EVENT GIVING RISE TO THE CLAIM,
|
|
108
|
+
OR TEN UNITED STATES DOLLARS (US $10.00), WHICHEVER IS GREATER.
|
|
109
|
+
|
|
110
|
+
10. Entire Agreement
|
|
111
|
+
|
|
112
|
+
This License is the entire agreement between you and Licensor regarding the
|
|
113
|
+
Software distributed under this License, and it supersedes any prior or
|
|
114
|
+
contemporaneous statements regarding that Software.
|
package/README.md
CHANGED
|
@@ -51,21 +51,25 @@ Required or commonly expected tools:
|
|
|
51
51
|
| Tool | Why it matters |
|
|
52
52
|
| --- | --- |
|
|
53
53
|
| `git` | Required for project repositories, worktrees, diffing, and commit operations |
|
|
54
|
-
| `opencode` |
|
|
55
|
-
| `claude` |
|
|
56
|
-
| `gh` |
|
|
54
|
+
| `opencode` | Needed for OpenCode-backed plan, build, chat, and review workflows |
|
|
55
|
+
| `claude` | Needed for Claude-backed workflows |
|
|
56
|
+
| `gh` | Optional for GitHub PR and review workflows; GitHub API key integration also works without it |
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
Archon should still start if an optional tool is missing, but features that depend on that binary or integration path will return actionable errors.
|
|
59
59
|
|
|
60
60
|
## How It Works
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
Archon has three main workspaces:
|
|
63
63
|
|
|
64
|
-
1. **
|
|
65
|
-
2. **
|
|
66
|
-
3. **
|
|
64
|
+
1. **Board**: create tickets, move them through planning and implementation, and run builds in isolated git worktrees on dedicated branches.
|
|
65
|
+
2. **Chat**: use persistent project chat sessions for planning, implementation help, and follow-up questions. Chat supports both planning-oriented and build-oriented turns so you can scope work first, then continue in the same conversation.
|
|
66
|
+
3. **Memory**: optionally save project conventions, accepted decisions, and other prompt context in Archon so future ticket, chat, build, and review runs stay aligned with how your project works.
|
|
67
|
+
|
|
68
|
+
Within the board workflow, tickets move through three stages:
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
1. **Plan**: write a title and description for the feature or task
|
|
71
|
+
2. **Build**: Archon runs your configured AI tool in a new git worktree and streams progress back to the UI in real time
|
|
72
|
+
3. **Review**: an agent reviews the resulting changes and suggests fixes that you can inspect and accept manually
|
|
69
73
|
|
|
70
74
|
## Project Setup
|
|
71
75
|
|
|
@@ -73,13 +77,13 @@ After Archon starts, create a project from the UI:
|
|
|
73
77
|
|
|
74
78
|
1. Click `Create project`
|
|
75
79
|
2. Enter a project name and repository path
|
|
76
|
-
3. Optionally click `Auto-config` to
|
|
80
|
+
3. Optionally click `Auto-config` to fill any empty setup, service, or worktree sync settings
|
|
77
81
|
4. Optionally open `Advanced settings` to review or edit setup, service, worktree sync, and IDE settings
|
|
78
82
|
5. Save the project, select it in the project switcher, and create tickets inside that project
|
|
79
83
|
|
|
80
84
|
## Project Configuration
|
|
81
85
|
|
|
82
|
-
|
|
86
|
+
Use the project form in the UI to configure how Archon prepares worktrees and runs project-specific services.
|
|
83
87
|
|
|
84
88
|
### Required fields
|
|
85
89
|
|
|
@@ -88,7 +92,7 @@ Archon stores repository and run settings per project in its database. Use the p
|
|
|
88
92
|
| `Project name` | The label shown in the project switcher, such as `Platform API` or `Marketing Site` |
|
|
89
93
|
| `Repository path` | Any path inside the target git repository; Archon resolves it to the repo root before saving |
|
|
90
94
|
|
|
91
|
-
`Auto-config` is available in both the create and edit project modals. It
|
|
95
|
+
`Auto-config` is available in both the create and edit project modals. It fills only empty `Setup commands`, `Services`, and `Worktree sync` sections, and it never changes `IDE command`.
|
|
92
96
|
|
|
93
97
|
### Advanced fields
|
|
94
98
|
|
|
@@ -100,10 +104,6 @@ Archon stores repository and run settings per project in its database. Use the p
|
|
|
100
104
|
| `cwd` | Optional working directory for a service, relative to the worktree root. For example, use `client` for a frontend dev server or `server` for an API process. Leave it blank to run from the worktree root. |
|
|
101
105
|
| `IDE command` | Optional command to open the finished worktree in your editor after services start, such as `code --reuse-window` or `idea`. |
|
|
102
106
|
|
|
103
|
-
Worktree sync entries are stored as `{ source, target?, mode }` objects. `source` is required, `target` is optional and defaults to the same path, and `mode` is either `copy` or `symlink`.
|
|
104
|
-
|
|
105
|
-
Service entries are stored as `{ cmd, cwd }` objects. `cmd` is required, while `cwd` is optional.
|
|
106
|
-
|
|
107
107
|
### Example project setup
|
|
108
108
|
|
|
109
109
|
```text
|
|
@@ -143,6 +143,10 @@ Default database locations:
|
|
|
143
143
|
|
|
144
144
|
You can override the database location with `DB_PATH`.
|
|
145
145
|
|
|
146
|
+
## License
|
|
147
|
+
|
|
148
|
+
Archon is distributed under the Archon Package License included with the npm package.
|
|
149
|
+
|
|
146
150
|
## Development And Maintenance
|
|
147
151
|
|
|
148
152
|
- Contributor workflow: [`DEVELOPMENT.md`](https://github.com/Straiffi/Archon/blob/main/DEVELOPMENT.md)
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@straiffi/archon",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
4
|
"private": false,
|
|
5
|
+
"license": "SEE LICENSE IN LICENSE",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"workspaces": [
|
|
7
8
|
"client",
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
},
|
|
13
14
|
"files": [
|
|
14
15
|
"dist",
|
|
15
|
-
"README.md"
|
|
16
|
+
"README.md",
|
|
17
|
+
"LICENSE"
|
|
16
18
|
],
|
|
17
19
|
"repository": {
|
|
18
20
|
"type": "git",
|