Skip to content

armgit / alook

Public Imported from GitHub
0

Multi-Agent Collaboration for Team and Friends

feat(cli): publish @alook/cli to npm via tag-driven OIDC workflow (#9)

Gener2621caac780a
diff --git a/.github/workflows/publish-cli.yml b/.github/workflows/publish-cli.yml
new file mode 100644
index 000000000..b17885c9f
--- /dev/null
+++ b/.github/workflows/publish-cli.yml
@@ -0,0 +1,59 @@
+name: Publish CLI
+
+on:
+ push:
+ tags: ["cli/v*"]
+
+concurrency:
+ group: publish-cli-${{ github.ref }}
+ cancel-in-progress: false
+
+jobs:
+ publish:
+ name: Publish @alook/cli to npm
+ runs-on: ubuntu-latest
+ timeout-minutes: 10
+ permissions:
+ id-token: write
+ contents: write
+ steps:
+ - name: Validate tag
+ run: |
+ if [[ ! "${GITHUB_REF_NAME}" =~ ^cli/v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
+ echo "::error::Tag ${GITHUB_REF_NAME} does not match cli/vX.Y.Z[-prerelease]"
+ exit 1
+ fi
+ echo "VERSION=${GITHUB_REF_NAME#cli/v}" >> "$GITHUB_ENV"
+
+ - uses: actions/checkout@v6
+
+ - uses: pnpm/action-setup@v6
+
+ - uses: oven-sh/setup-bun@v2
+
+ - uses: actions/setup-node@v6
+ with:
+ node-version: 22
+ registry-url: https://registry.npmjs.org
+ cache: pnpm
+
+ - name: Upgrade npm for Trusted Publishers
+ run: npm install -g npm@latest
+
+ - run: pnpm install --frozen-lockfile
+
+ - name: Set CLI package version
+ working-directory: src/cli
+ run: npm version "$VERSION" --no-git-tag-version --allow-same-version
+
+ - name: Build CLI bundle
+ run: pnpm -C src/cli run build
+
+ - name: Publish to npm (OIDC + provenance)
+ working-directory: src/cli
+ run: npm publish --provenance --access public
+
+ - name: Create GitHub release
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: gh release create "$GITHUB_REF_NAME" --generate-notes --title "CLI v$VERSION"
diff --git a/.gitignore b/.gitignore
index 4cb2d8cb3..604a894bf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,4 +17,5 @@ plans/
.context_timeline/
.claude/
.impeccable.md
-.playwright-mcp/
\ No newline at end of file
+.playwright-mcp/
+src/cli/LICENSE
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 000000000..dfbb4b150
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for describing the origin of the Work and
+ reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Support. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or support.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2026 Alook
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied. See the License for the specific language governing permissions
+ and limitations under the License.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 55287fa80..5c684a6dc 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -23,9 +23,6 @@ importers:
src/cli:
dependencies:
- '@alook/shared':
- specifier: workspace:*
- version: link:../shared
citty:
specifier: ^0.2.2
version: 0.2.2
@@ -36,6 +33,9 @@ importers:
specifier: ^2.7.4
version: 2.7.4
devDependencies:
+ '@alook/shared':
+ specifier: workspace:*
+ version: link:../shared
'@types/bun':
specifier: ^1.3.12
version: 1.3.12
diff --git a/src/cli/README.md b/src/cli/README.md
new file mode 100644
index 000000000..041aac428
--- /dev/null
+++ b/src/cli/README.md
@@ -0,0 +1,47 @@
+# @alook/cli
+
+Alook CLI — register and run always-on AI coding agents.
+
+## Install
+
+```bash
+npx @alook/cli <command>
+```
+
+Or install globally:
+
+```bash
+npm install -g @alook/cli
+alook <command>
+```
+
+## Quick start
+
+Register this machine with your Alook account:
+
+```bash
+npx @alook/cli register --token al_xxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+You can generate a token from the Alook dashboard.
+
+## Commands
+
+| Command | Description |
+| --- | --- |
+| `alook register` | Register this machine with your Alook account. |
+| `alook status` | Show current registration status. |
+| `alook daemon` | Manage the local Alook daemon. |
+| `alook email` | Manage agent emails. |
+| `alook config` | Manage CLI configuration. |
+| `alook version` | Print the CLI version. |
+
+Run `alook <command> --help` for subcommand options.
+
+## Requirements
+
+- Node.js ≥ 20
+
+## License
+
+Apache-2.0 — see [LICENSE](../../LICENSE).
diff --git a/src/cli/RELEASING.md b/src/cli/RELEASING.md
new file mode 100644
index 000000000..5f7b6a72a
--- /dev/null
+++ b/src/cli/RELEASING.md
@@ -0,0 +1,47 @@
+# Releasing @alook/cli
+
+Releases are triggered by pushing a tag of the form `cli/vX.Y.Z`:
+
+```bash
+git tag cli/v0.2.0
+git push origin cli/v0.2.0
+```
+
+The [`Publish CLI`](../../.github/workflows/publish-cli.yml) workflow will:
+
+1. Validate the tag format (`cli/vX.Y.Z` or `cli/vX.Y.Z-prerelease`)
+2. Set `src/cli/package.json` version to the tag's version (in-job, not committed)
+3. Build the Node ESM bundle (inlines `@alook/shared` and its deps)
+4. Publish `@alook/[email protected]` to npm via **OIDC + provenance**
+5. Create a GitHub Release with auto-generated notes
+
+No npm token lives in CI. The package is registered with [Trusted Publishers](https://docs.npmjs.com/trusted-publishers) on npmjs.com.
+
+## Prerelease versions
+
+Use tags like `cli/v0.2.0-beta.1` or `cli/v1.0.0-rc.1`. The npm `latest` dist-tag is **not** automatically moved for prereleases — users pin with `npm i @alook/[email protected]`.
+
+If you want a `next` dist-tag, pass `--tag next` to the publish step (requires editing the workflow).
+
+## Rolling back
+
+Within 72h of publishing, you can unpublish a specific version:
+
+```bash
+npm unpublish @alook/[email protected]
+```
+
+After 72h, use deprecation instead:
+
+```bash
+npm deprecate @alook/[email protected] "broken release, please upgrade to 0.2.1"
+```
+
+## Local smoke test before tagging
+
+```bash
+cd src/cli
+pnpm run build
+node dist/index.js --help
+npm pack --dry-run # inspect the tarball contents
+```
diff --git a/src/cli/package.json b/src/cli/package.json
index 873a6b86a..5b0723591 100644
--- a/src/cli/package.json
+++ b/src/cli/package.json
@@ -1,21 +1,55 @@
{
"name": "@alook/cli",
"version": "0.0.1",
- "private": true,
+ "description": "Alook CLI — register and run always-on AI coding agents.",
+ "license": "Apache-2.0",
+ "homepage": "https://github.com/alookai/alook#readme",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/alookai/alook.git",
+ "directory": "src/cli"
+ },
+ "bugs": {
+ "url": "https://github.com/alookai/alook/issues"
+ },
+ "keywords": [
+ "alook",
+ "cli",
+ "ai",
+ "agent",
+ "daemon",
+ "email"
+ ],
"type": "module",
+ "bin": {
+ "alook": "dist/index.js"
+ },
+ "main": "./dist/index.js",
+ "files": [
+ "dist",
+ "README.md",
+ "LICENSE"
+ ],
+ "engines": {
+ "node": ">=20"
+ },
+ "publishConfig": {
+ "access": "public"
+ },
"scripts": {
"dev": "bun run src/index.ts",
- "build": "bun build src/index.ts --outdir dist --target bun",
+ "build": "bun build src/index.ts --outdir dist --target node --format esm --external citty --external commander --external postal-mime && node scripts/prepare-dist.mjs",
+ "prepack": "pnpm run build",
"test": "vitest run",
"typecheck": "tsc --noEmit"
},
"dependencies": {
- "@alook/shared": "workspace:*",
"citty": "^0.2.2",
"commander": "^14.0.3",
"postal-mime": "^2.7.4"
},
"devDependencies": {
+ "@alook/shared": "workspace:*",
"@types/bun": "^1.3.12",
"typescript": "^6.0.2",
"vitest": "^4.1.4"
diff --git a/src/cli/scripts/prepare-dist.mjs b/src/cli/scripts/prepare-dist.mjs
new file mode 100644
index 000000000..5e3a0f53e
--- /dev/null
+++ b/src/cli/scripts/prepare-dist.mjs
@@ -0,0 +1,16 @@
+import { readFileSync, writeFileSync, chmodSync, copyFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+const entry = resolve("dist/index.js");
+const src = readFileSync(entry, "utf8");
+const shebang = "#!/usr/bin/env node\n";
+if (!src.startsWith(shebang)) {
+ writeFileSync(entry, shebang + src);
+}
+chmodSync(entry, 0o755);
+console.log("prepared", entry);
+
+const rootLicense = resolve("../../LICENSE");
+const packageLicense = resolve("LICENSE");
+copyFileSync(rootLicense, packageLicense);
+console.log("copied", rootLicense, "->", packageLicense);