@gyub.s/codex-skill-shopl-sprint-planner
v0.1.0
Published
Codex skill installer for the Shopl sprint planner workflow.
Maintainers
Readme
Shopl Sprint Planner
Install the shopl-sprint-planner Codex skill from npm and load it into your local Codex skills directory.
What It Installs
SKILL.mdagents/openai.yaml
The installer copies both files into:
$CODEX_HOME/skills/shopl-sprint-planner, or~/.codex/skills/shopl-sprint-plannerwhenCODEX_HOMEis not set
Requirements
- Node.js 18+
- npm
- Codex with local skill loading enabled
Quick Start
Run the installer directly from npm:
npx @gyub.s/codex-skill-shopl-sprint-plannerThen start a new Codex session. The skill will be available as shopl-sprint-planner.
Global Install
If you want a reusable local command:
npm install -g @gyub.s/codex-skill-shopl-sprint-planner
shopl-sprint-plannerThe legacy alias also works:
shopl-sprint-planner-skillCustom Target Directory
Install into a custom skills directory:
npx @gyub.s/codex-skill-shopl-sprint-planner -- --target /path/to/skillsPreview the install without writing files:
npx @gyub.s/codex-skill-shopl-sprint-planner -- --dry-runVerify Installation
Check that the files were copied:
ls ~/.codex/skills/shopl-sprint-plannerExpected files:
SKILL.mdagents/openai.yaml
Usage
In a new Codex session, invoke the skill with a prompt such as:
Use $shopl-sprint-planner to interview me, split a Shopl upper Jira ticket, create real child tickets first when needed, and write docs/work-plans.Publish To npm
If you are publishing this package for the first time:
npm login
npm run release:check
npm publishOr publish through GitHub Actions:
- Add
NPM_TOKENto the repository secrets. - Push a tag such as
v0.1.0. - The workflow at
.github/workflows/publish.ymlwill validate and publish the package.
Continuous Publish Without Web
You can set up repeatable npm publishing without opening the npm or GitHub web UI each time.
1. Create a publish token from the CLI
Create a write token that can bypass 2FA for publish automation:
npx [email protected] token create \
--name "shopl-sprint-planner-publish" \
--token-description "shopl-sprint-planner publish" \
--scopes gyub.s \
--packages-and-scopes-permission read-write \
--bypass-2fa=trueIf your locally installed npm already supports granular token creation, this also works:
npm token create \
--name "shopl-sprint-planner-publish" \
--token-description "shopl-sprint-planner publish" \
--scopes gyub.s \
--packages-and-scopes-permission read-write \
--bypass-2fa=trueNotes:
- npm may prompt for your password and one-time password during token creation.
- This is a one-time setup step for generating the token.
- npm's latest CLI docs describe
npm token createsupport for granular tokens andbypass-2fa. - On the machine used for this repository,
npm 11.6.2did not recognize the granular token flags, sonpx [email protected] ...is the safer command.
2. Export the token in your shell
export NPM_TOKEN="paste-the-token-here"3. Persist it locally and in GitHub Actions
This command writes the token to ~/.npmrc and, if gh is authenticated, sets the repository secret NPM_TOKEN without opening GitHub in a browser:
npm run setup:publish-token -- --gh-secretDry-run:
npm run setup:publish-token -- --gh-secret --dry-run4. Publish continuously
Local publish with the stored token:
npm publishGitHub Actions publish by tag:
git tag v0.1.0
git push origin v0.1.0The workflow at .github/workflows/publish.yml uses the NPM_TOKEN secret for non-interactive publishing.
Notes:
- The current package name is
@gyub.s/codex-skill-shopl-sprint-planner. - The
@gyub.snpm user scope belongs to thegyub.snpm account. publishConfig.accessis set topublic. If you want a private org package instead, change it back torestrictedbefore publishing.- The package is currently marked
UNLICENSED. If this will be distributed outside your company, choose an explicit license first.
