Skip to content

Add quick local run instructions to README - #360

Merged
chiragjn merged 3 commits into
truefoundry:mainfrom
suraj07nangare:patch-1
Aug 24, 2026
Merged

chiragjn merged 3 commits into
truefoundry:mainfrom
suraj07nangare:patch-1

Conversation

@suraj07nangare

@suraj07nangare suraj07nangare commented Aug 19, 2026 •

Copy link
Copy Markdown
Contributor

Added instructions for a quick local run without Docker.

Summary

Closes #

Changes

How was this tested?

Checklist

  • pnpm build, pnpm test, pnpm typecheck, pnpm lint:ci, and pnpm format:check pass locally
  • Tests added/updated where it makes sense
  • No hand-edits to generated code (packages/trueforge-sdk, .github/fern/openapi/openapi.json, docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge
  • Docs / .env.example updated if configuration or behavior changed

Note

Low Risk
Documentation-only README change; no code, auth, or runtime behavior is affected.

Overview
Puts a one-command local start in the README Getting started section: npx @truefoundry/trueforge.

The previous single-line pointer to the Quickstart is replaced with that snippet plus a short note that Local, Docker Compose, and Kubernetes still live in the Quickstart guide.

Reviewed by Cursor Bugbot for commit ffa25e7. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Aug 19, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ffa25e7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Comment thread README.md Resolved
@innoavator
innoavator enabled auto-merge (squash) August 20, 2026 04:05
@thesujai

thesujai commented Aug 21, 2026 •

Copy link
Copy Markdown
Contributor

Hi @suraj07nangare, there are some lint failures. Can you ensure pnpm build, pnpm test, pnpm typecheck, pnpm lint:ci, and pnpm format:check passes locally and then push your changes?

suraj07nangare and others added 3 commits August 24, 2026 15:01
Added instructions for a quick local run without Docker.
Added instructions for quickstart using `npx` and clarified usage methods.
@chiragjn
chiragjn disabled auto-merge August 24, 2026 09:31
@chiragjn
chiragjn merged commit ad752c4 into truefoundry:main Aug 24, 2026
5 checks passed
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.

4 participants