npm package setup required

[timimsms]

npm Package Setup Checklist

This issue tracks the manual steps required to enable npm distribution after PR #4 is merged.

Prerequisites

• Create npm account at https://www.npmjs.com if you don't have one
• Verify email address on npm

Package Setup

• Reserve package name by publishing initial version:

  cd npm
  npm login
  npm publish --access public

• Verify package at https://www.npmjs.com/package/@clickup/cli

GitHub Configuration

• Generate npm token:
  1. Go to https://www.npmjs.com/settings/[username]/tokens
  2. Create new token with "Automation" type
  3. Copy the token
• Add NPM_TOKEN to GitHub secrets:
  1. Go to Settings → Secrets and variables → Actions
  2. Add new secret named NPM_TOKEN
  3. Paste the npm token value

Release Workflow Update

• Add npm publish step to .github/workflows/release.yml:

  - name: Publish to npm
    if: success()
    env:
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
      GITHUB_REF_NAME: ${{ github.ref_name }}
    run: |
      ./scripts/publish-npm.sh

Verification

• Create a test release to verify npm publishing works
• Test installation: npm install -g @clickup/cli
• Verify binary downloads and runs correctly

Important Notes

• The package name @clickup/cli requires either:
  • Ownership of the @clickup npm organization
  • Or use an alternative like clickup-cli (without scope)
• First version must be published manually to claim the name
• npm tokens expire after 1 year by default

Alternative Package Names

If @clickup/cli is not available, consider:

• clickup-cli
• cu-cli
• @timimsms/clickup-cli (personal scope)

---

Related to PR #4

[timimsms]

Status update (Feb 2026): npm distribution is a lower priority than Homebrew + direct download, which are now set up via PR #17.

For Go CLI tools, the recommended distribution pipeline is:

1. GoReleaser + GitHub Releases (done - PR feat: add GoReleaser and release workflow for distribution #17)
2. Homebrew Tap (done - PR feat: add GoReleaser and release workflow for distribution #17)
3. go install (already works)
4. npm wrapper (this issue — future, optional)

Keeping this open but deprioritizing. The npm wrapper approach (downloading platform-specific binaries in postinstall) adds complexity and maintenance burden. Most developers who use ClickUp and want a CLI will have Homebrew or can download a binary directly.

[timimsms]

Decisions made on naming and next steps:

• npm package name will be @timimsms/cu.
  • @clickup/cli is ClickUp's own namespace and a trademark risk for an unofficial CLI.
  • clickup-cli has been taken by a third party on npm since 2022; clickup-cu is also taken.
• PR feat: add npm package wrapper for global installation #4 was closed unmerged. The wrapper work survives on branch feat/npm-package and should be revived under the new name after v0.1.0 ships.

[timimsms]

Status update: @timimsms/cu is claimed on npm (placeholder 0.0.1 published: https://www.npmjs.com/package/@timimsms/cu).

Decision on tokens: no NPM_TOKEN secret will be stored. npm is deprecating 2FA-bypass automation tokens (account actions ~Aug 2026, direct publishing ~Jan 2027), so the release pipeline will use Trusted Publishing (OIDC) instead. That setup requires the concrete publish workflow filename, so it happens when the npm pipeline is built — the sequence is: revive the wrapper from feat/npm-package under the new name, add a publish job to the release workflow, then link the OIDC trusted publisher on npmjs.com to that workflow.

Cosmetic note from the placeholder publish: npm normalized repository.url to git+https://… — run npm pkg fix in the real package to keep it tidy.