agent-profile-kit 0.204.1 → 0.237.0

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.
Files changed (7) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +20 -11
  3. package/dist/cli.js +9136 -10643
  4. package/docs/guides/agent-workflow.md +82 -41
  5. package/docs/guides/workspace-contract.md +502 -0
  6. package/docs/guides/workspace.md +153 -141
  7. package/package.json +9 -5
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Kenneth Liao
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,8 +1,7 @@
1
1
  # Agent Profile Kit
2
2
 
3
3
  Agent Profile Kit composes your Skills and Context into portable Profiles and
4
- installs them into the projects you choose, as native material for your Agent
5
- Hosts.
4
+ installs them into the projects you choose, as native material for your agents.
6
5
 
7
6
  The initial release supports macOS only, on the Node.js 22 line — the package's
8
7
  declared primary Node runtime; no newer Node release line is claimed. The
@@ -12,26 +11,32 @@ evidence. Supporting additional environments is an explicit decision backed by
12
11
  matching packed installation and lifecycle evidence, never an engine-range
13
12
  promise.
14
13
 
15
- Supported Hosts: Antigravity, Codex, Claude Code, Grok, OpenCode, and Pi.
14
+ Supported agents: Antigravity, Codex, Claude Code, Grok, OpenCode, and Pi.
15
+
16
+ ## Agent-first setup
17
+
18
+ If you are using an AI coding agent, you do not need to run commands by hand. Paste this prompt into your agent:
19
+
20
+ > Read https://github.com/kenneth-liao/agent-profile-kit (specifically `docs/guides/agent-workflow.md` and `docs/guides/workspace-contract.md`, or run `npx --yes --package agent-profile-kit apkit guide --agent`), then help me set up my Workspace, migrate my existing Skills and instruction files, create my first Profile, and install it into my projects.
16
21
 
17
22
  ## Quick start
18
23
 
19
- Initialize your Workspace without a global installation:
24
+ Initialize your Workspace in a folder you choose, without a global installation:
20
25
 
21
26
  ```sh
22
- npx --package agent-profile-kit apkit init
23
- # Or choose one explicit Workspace path:
24
27
  npx --package agent-profile-kit apkit init ~/projects/agent-profile-workspace
28
+ # Or use the current folder as your Workspace:
29
+ npx --package agent-profile-kit apkit init .
25
30
  ```
26
31
 
27
32
  ## First run
28
33
 
29
34
  ```sh
30
- apkit init # scaffold your Workspace
31
- apkit install <profile> --host <host> # install a Profile into the current project
32
- apkit status # review the fleet plan
33
- apkit update # refresh installations from the Workspace (fleet by default)
34
- apkit uninstall --here --auto-confirm # remove an installation and forget its selection
35
+ apkit init <path> # set up your Workspace in the folder you name (`.` uses the current folder)
36
+ apkit install <profile> --agent <agent> # install a Profile into the current project
37
+ apkit status # review the fleet plan
38
+ apkit update # refresh installations from the Workspace (fleet by default)
39
+ apkit uninstall --here --auto-confirm # remove an installation and forget its selection
35
40
  ```
36
41
 
37
42
  `apkit update` narrows to one Project with `--here` or `--project <path>`;
@@ -40,6 +45,10 @@ apkit uninstall --here --auto-confirm # remove an installation and forget its
40
45
  ## Learn more
41
46
 
42
47
  - `apkit --help` — concise summary of every command
48
+ - `apkit guide --agent` — step-by-step agent onboarding, migration, and authoring workflow
43
49
  - `apkit guide profile` (or `guide context`, `guide skill`) — focused authoring topics
50
+ - `apkit guide --contract` — the Workspace contract: every rule validation enforces
44
51
  - `apkit guide --full` — the complete Workspace guide
52
+ - [docs/guides/agent-workflow.md](docs/guides/agent-workflow.md) — agent onboarding and migration guide, readable before installing apkit
53
+ - [docs/guides/workspace-contract.md](docs/guides/workspace-contract.md) — the Workspace contract, readable before installing apkit
45
54
  - [docs/guides/workspace.md](docs/guides/workspace.md) — Workspace authoring guidance