Repository navigation
Add quick local run instructions to README - #360
Merged
Merged
Conversation
suraj07nangare
requested review from
bhaveshpatel640,
chiragjn,
debajyoti-truefoundry,
heerambavi1998,
sr07asthana and
thesujai
as code owners
August 19, 2026 16:01
|
innoavator
requested changes
Aug 19, 2026
innoavator
approved these changes
Aug 20, 2026
innoavator
enabled auto-merge (squash)
August 20, 2026 04:05
Contributor
|
Hi @suraj07nangare, there are some lint failures. Can you ensure |
Added instructions for a quick local run without Docker.
Added instructions for quickstart using `npx` and clarified usage methods.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, andpnpm format:checkpass locallypackages/trueforge-sdk,.github/fern/openapi/openapi.json,docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge.env.exampleupdated if configuration or behavior changedNote
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.