Skip to content

Document npm installation alongside PyPI - #351

Merged
dipeshbabu merged 3 commits into
mainfrom
docs/npm-install
Nov 19, 2026
Merged

dipeshbabu merged 3 commits into
mainfrom
docs/npm-install

Conversation

@dipeshbabu

@dipeshbabu dipeshbabu commented Nov 19, 2026 •

Copy link
Copy Markdown
Owner

The README only mentioned npm in one sentence (describing the SDK as part of the source checkout), and several guides still said npm publication was pending.

  • README: npm badge; Install section (PyPI / npm / standalone table, how the packages relate); Quickstart keeps the copy-paste pip line; From TypeScript or JavaScript tracing example; integrations table rows for the TypeScript SDK and the Codex/Claude Code runners; Dashboard section names the TypeScript API client.
  • docs/installation.md: intro covers both packages; TypeScript section documents `npm install`, upgrade (`@latest`), `npm ls` version check, entry points, provenance, SDK guide link.
  • docs/UPGRADING.md: npm upgrade note; the 0.1.1 note no longer claims npm is pending.
  • docs/API_VERSIONING.md: points to the TypeScript `AgentLoopClient`.
  • docs/index.md: npm pointer under the first-trace example.
  • Changelog entries.

The JavaScript example was run against `agentloop-profiler@0.1.1` from npm on Node 22 and its trace analyzed with the CLI. `mkdocs build --strict` (links resolve to the generated SDK page and its `#use-the-api` anchor), README/docs tests and pre-commit pass locally.

🤖 Generated with Claude Code

The README mentioned the npm TypeScript SDK only in passing (as part of
the source checkout) and the installation guide still said npm
publication was pending. Add an Install section with PyPI, npm and
standalone options, an npm badge and a JavaScript tracing example
checked against the published package, and document npm installation in
the installation guide and docs home page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

AgentLoop replay self-test

This required repository check evaluates generated synthetic demo traces. It tests the replay and CI machinery; it does not show that this PR improves application performance.

AgentLoop CI Report

  • Status: passed
  • Replay: Replay passed: latency improvement 69.67%, cost improvement 78.82%, retry delta -1.
  • Merge recommendation: synthetic self-test only; assess application traces before merge
  • Findings: 1 total, 0 high severity, 1 patchable

Performance Gates

Gate Status Detail
latency_regression pass 0.00% regression <= 0.00% allowed
cost_regression pass 0.00% regression <= 0.00% allowed
latency_improvement pass 69.67% improvement >= 20.00% required
cost_improvement pass 78.82% improvement >= 5.00% required
retry_non_increase pass 0 candidate retries <= 1 baseline retries

Trace inputs

This comparison includes synthetic data. It does not establish application performance gains from a pull request.

Side Run ID Path Synthetic marker Source
baseline run_ff2d783d909a40d0 runs/research_agent_baseline.json yes agentloop_demo
candidate run_62f382ce1e8c44f6 runs/research_agent_optimized.json yes agentloop_demo

Metric Impact

Metric Impact
Latency improvement 69.67%
Cost improvement 78.82%
Retry delta -1
Candidate schema validity not provided
Candidate quality score not provided

Top Findings

Finding Severity Type Rewrite
al_cache_context_c11e63e73ec3: Cache repeated prompt/context prefix medium cache_context Move stable instructions into cached prefixes, summaries, or framework-level memory instead of resending full text.

dipeshbabu and others added 2 commits November 19, 2026 01:22
The integrations table now lists the TypeScript SDK and the coding-agent
runners, the README notes the TypeScript API client, the upgrade guide no
longer says npm publication is pending, the API guide points to the
TypeScript client, and the installation guide shows how to upgrade and
check the npm package.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The SDK README, also shown on npmjs.com, said to analyze traces with the Python CLI without saying how to install it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dipeshbabu
dipeshbabu merged commit 413f1e5 into main Nov 19, 2026
25 checks passed
@dipeshbabu
dipeshbabu deleted the docs/npm-install branch November 19, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant