feat!: rename run to function

[Kikobeats]

Summary

• Drop the run CLI command and SDK method; function is the only name.
• Update types, tests, and docs to match.

Test plan

• pnpm --filter microlink.io test
• microlink function https://example.com --file ./fn.js works
• microlink run reports an unknown command

Made with Cursor

Summary by CodeRabbit

• Breaking Changes
  • The remote JavaScript execution API is now available exclusively as function; the run client method and alias are no longer supported.
  • Updated documentation and examples to use microlink.function(...).
  • The run CLI command no longer invokes the function product or supports function-specific file execution.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 40321631-7094-4251-ae80-8dbc28a848eb

📥 Commits

Reviewing files that changed from the base of the PR and between bc3d77c and 67f9c74.

📒 Files selected for processing (9)

• README.md
• packages/core/bin/help.js
• packages/core/bin/run.js
• packages/core/src/index.d.ts
• packages/core/src/index.js
• packages/core/test/build.mjs
• packages/core/test/index.test-d.ts
• packages/core/test/integration.mjs
• packages/core/test/unit.mjs

💤 Files with no reviewable changes (3)

• packages/core/test/build.mjs
• packages/core/src/index.d.ts
• packages/core/test/index.test-d.ts

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The PR removes the run client alias for remote JavaScript execution. CLI routing, type declarations, tests, and README examples now use function.

Changes

Remove run alias

Layer / File(s)	Summary
Client API and execution tests packages/core/src/index.d.ts, packages/core/src/index.js, packages/core/test/*	The client no longer exposes run. The function method retains the execution logic, and tests validate the updated API.
CLI command routing packages/core/bin/help.js, packages/core/bin/run.js	CLI help and dispatch no longer resolve run as function. File validation and file-based invocation apply only to function.
Function documentation README.md	The product name, section heading, examples, and related entry use function.

Priority: ➖ Normal — Schedule the SDK and CLI rename because removing the public `run` API is a breaking change for consumers using `microlink.run()` or `microlink run`.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 67f9c

The rename removes the run SDK and CLI interfaces while retaining function behavior and documenting the new name. No merge-blocking current-head risk remains.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely identifies the breaking change from run to function, which matches the pull request's main objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 5…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/rename-run-to-function

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coveralls]

Coverage Report for CI Build 34236854592

Warning

No base build found for commit bc3d77c on master.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 77.928%

Details

• Patch coverage: 9 of 9 lines across 3 files are fully covered (100%).

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →

---

Coverage Stats

Relevant Lines:	4875
Covered Lines:	3804
Line Coverage:	78.03%
Relevant Branches:	820
Covered Branches:	634
Branch Coverage:	77.32%
Branches in Coverage %:	Yes
Coverage Strength:	24.13 hits per line

---

💛 - Coveralls