Merge branch 'next' into kanad-2025-10-07/working-directory-CX-2286

Author: kanadgupta

CONTRIBUTING.md

@@ -26,6 +26,10 @@ bin/run.js openapi validate __tests__/__fixtures__/ref-oas/petstore.json
 
 Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [`MAINTAINERS.md`](./MAINTAINERS.md).
 
+## ReadMe Development 🦉
+
+If you're a ReadMe team member that's testing `rdme` against a non-production ReadMe environment, you can either set the `RDME_LOCALHOST=true` environment variable (which points your CLI to the localhost version of ReadMe) or modify the URLs in `src/lib/config.ts` directly.
+
 ## Running GitHub Actions Locally 🐳
 
 To run GitHub Actions locally, we'll be using [`act`](https://github.com/nektos/act) (make sure to read their [prerequisites list](https://github.com/nektos/act#necessary-prerequisites-for-running-act) and have that ready to go before installing `act`)!

README.md

@@ -114,11 +114,11 @@ For local CLI usage with a single project, you can authenticate `rdme` to your R
 > [!WARNING]
 > For security reasons, we strongly recommend providing a project API key via the `--key` option in automations or CI environments (GitHub Actions, CircleCI, Travis CI, etc.). It's also recommended if you're working with multiple ReadMe projects to avoid accidentally overwriting existing data.
 
-You can also pass in your API key via environmental variable. Here is the order of precedence when passing your API key into `rdme`:
+You can also pass in your API key via environment variable. Here is the order of precedence when passing your API key into `rdme`:
 
 1. The `--key` option. If that isn't present, we look for...
-1. The `RDME_API_KEY` environmental variable. If that isn't present, we look for...
-1. The `README_API_KEY` environmental variable. If that isn't present, we look for...
+1. The `RDME_API_KEY` environment variable. If that isn't present, we look for...
+1. The `README_API_KEY` environment variable. If that isn't present, we look for...
 1. The API key value stored in your local configuration file (i.e., the one set via `rdme login`)
 
 `rdme whoami` is also available to you to determine who is logged in, and to what project. You can clear your stored credentials with `rdme logout`.
@@ -133,7 +133,7 @@ To set this up, check out [1Password's documentation on the ReadMe shell plugin]
 
 ## Proxy
 
-`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environmental variable.
+`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environment variable.
 
 ```sh
 export HTTPS_PROXY=https://proxy.example.com:5678

documentation/synced/legacy/rdme.mdx

@@ -293,7 +293,7 @@ If you're working with the `docs` command specifically, we recommend using [dry
 
 ### Troubleshooting CLI
 
-If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environmental variable to print helpful debugging info to the console:
+If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environment variable to print helpful debugging info to the console:
 
 ```sh
 DEBUG=rdme* rdme openapi validate [url-or-local-path-to-file]

documentation/synced/rdme.mdx

@@ -343,7 +343,7 @@ If you're working with the Markdown upload commands (e.g., `docs upload`, `refer
 
 ### Troubleshooting CLI
 
-If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environmental variable to print helpful debugging info to the console:
+If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environment variable to print helpful debugging info to the console:
 
 ```sh
 DEBUG=rdme* rdme openapi upload [url-or-local-path-to-file] --key=...

package.json

@@ -13,6 +13,7 @@
   "files": [
     "/bin/run*",
     "/dist",
+    "/documentation",
     "/oclif.manifest.json"
   ],
   "keywords": [

src/lib/config.ts

@@ -1,7 +1,7 @@
 const config = {
   host: {
-    v1: 'https://dash.readme.com',
-    v2: 'https://api.readme.com/v2',
+    v1: process.env.RDME_LOCALHOST ? 'http://dash.readme.local:3000' : 'https://dash.readme.com',
+    v2: process.env.RDME_LOCALHOST ? 'http://api.readme.local:3000/v2' : 'https://api.readme.com/v2',
   },
 } as const;