Skip to content

docs: [FUN-564] Add link to ref docs in Dev server README #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tvarney13 merged 6 commits into from
Feb 25, 2025
Merged

docs: [FUN-564] Add link to ref docs in Dev server README #506

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
19ea80f
Add link to ref docs in Dev server README
tvarney13 Feb 25, 2025
65948cb
move into main readme
tvarney13 Feb 25, 2025
ea0e8a3
newline
tvarney13 Feb 25, 2025
8b30faa
copy blurb from ref docs
tvarney13 Feb 25, 2025
d7cf9f8
remove extra whitespace
tvarney13 Feb 25, 2025
ddd1ea3
migrate text, pare down words
tvarney13 Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,9 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply

[ghrelease-badge]: https://img.shields.io/github/release/launchdarkly/ldcli.svg
[ghrelease-link]: https://github.com/launchdarkly/ldcli/releases/latest

## Dev Server

LaunchDarkly provides a command line interface (CLI), which includes a `dev-server` command that you can use to start a local server and retrieve flag values from a LaunchDarkly source environment. This development server supports a single variation value for each flag, which you can override as needed. This means you can test your code locally, and you do not need to coordinate with other developers in your organization who are using the same LaunchDarkly source environment.
Copy link

@mike-zorn mike-zorn Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want this at line 98: we're just documenting the dev-server command and linking out to additional documentation about it. We also can remove the "LaunchDarkly provides a command line interface (CLI), which includes a" bit. If someone is reading this readme, they already know that.


For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server).
Loading