Skip to content

91-local-development.md

Latest commit

 

History

History
151 lines (111 loc) · 3.52 KB

91-local-development.md

File metadata and controls

151 lines (111 loc) · 3.52 KB

Local Development

For Generated Projects

After harbor init:

pnpm install
pnpm install --dir collector

pnpm collect
pnpm post-collect
pnpm dev
pnpm build
pnpm preview

These scripts expand to:

  • pnpm collect → node collector/node_modules/agent-skill-harbor-collector/dist/src/runtime/collect-command.js
  • pnpm post-collect → node collector/node_modules/agent-skill-harbor-collector/dist/src/runtime/post-collect-command.js
  • pnpm dev → node node_modules/agent-skill-harbor/dist/src/runtime/dev.js
  • pnpm build → node node_modules/agent-skill-harbor/dist/src/runtime/build.js
  • pnpm preview → node node_modules/agent-skill-harbor/dist/src/runtime/preview.js

Testing Unpublished Local Packages in a Generated Project

If you want to verify generated-project behavior before npm publish, the simplest option is to point dependencies at the local working tree.

In the generated project:

  • set package.json to file:/absolute/path/to/agent-skill-harbor
  • set collector/package.json to file:/absolute/path/to/agent-skill-harbor/collector

Example:

{
	"dependencies": {
		"agent-skill-harbor": "file:/Users/you/ws/agent-skill-harbor"
	}
}
{
	"dependencies": {
		"agent-skill-harbor-collector": "file:/Users/you/ws/agent-skill-harbor/collector"
	}
}

Then rebuild the local packages and reinstall them in the generated project:

cd /absolute/path/to/agent-skill-harbor
pnpm cli:build
pnpm --dir collector build

cd /absolute/path/to/generated-project
pnpm install
pnpm install --dir collector

For Contributors

Prerequisites

  • Node.js 24+
  • pnpm 10+

Getting Started

git clone https://github.com/skill-mill/agent-skill-harbor.git
cd agent-skill-harbor

pnpm install
pnpm --dir collector install
pnpm setup:dev

pnpm cli:build
pnpm --dir collector build
pnpm dev

The development server starts at http://localhost:5173.

pnpm setup:dev prepares the repository root as a demo project by:

  1. copying templates/init/.env.example to .env.example and .env
  2. downloading demo config/, data/, and guide/

Useful Commands

pnpm verify
pnpm --dir collector verify

pnpm build
pnpm cli:build
pnpm --dir collector build
pnpm storybook
pnpm storybook:build

pnpm dev
pnpm build
pnpm preview

GH_TOKEN=$(gh auth token) node collector/dist/src/runtime/collect-command.js
node collector/dist/src/runtime/post-collect-command.js --collect-id <collect_id>

Layout

agent-skill-harbor/
├── bin/                  # harbor CLI entrypoint
├── src/                  # CLI + web sources
├── collector/            # collector + post-collect package
│   ├── bin/
│   ├── src/
│   └── plugins/
├── templates/            # init/setup templates
├── static/
├── guide/
├── docs/
├── config/
└── data/

Architecture Notes

  • root package (agent-skill-harbor) owns CLI + web
  • collector/ package (agent-skill-harbor-collector) owns collect + post-collect
  • optional plugin manifests live under collector/plugins/<plugin-id>/
  • collector core and optional plugin dependencies remain separate install surfaces
  • built-in notify-slack is part of collector core

Why collect and post_collect stay separate in workflows

The reusable workflow still uses two jobs:

  • collect
  • post_collect

This is intentional for:

  • artifact boundary
  • easier reruns of post-collect only
  • clearer security separation between GitHub collection and optional plugin dependencies