Conversation
| | `resource_api` | Starts with `https://`, does not end with `/` | `https://m90q55iux6.execute-api.eu-west-2.amazonaws.com` | | ||
|
|
||
| **Note:** Every password is tied to a specific environment. A password for the production environment, for example, won't grant access to the development environment. Ensure you set the correct `UE_PASSWORD` value for the environment you configure. | ||
|
|
Contributor
There was a problem hiding this comment.
I think we should also include this line somewhere in this section as a reminder:
Note
If you are switching between different environments, you need to delete your ~/.ue_auth file before trying to change between the environments.
It is something that is coming up a lot, and it will be useful to make it clear in the documentation that when people are switching between environments, they shouldn't forget this step.
…-back-into-sdk-project
…he if authentication fails
eirinikouvara
approved these changes
Mar 25, 2026
Contributor
eirinikouvara
left a comment
eirinikouvara
left a comment
There was a problem hiding this comment.
Ooh, I really like the clarification for Windows too :)
cariad
deleted the
PB-1750-cariad-add-docs-about-custom-sdk-env-back-into-sdk-project
branch
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.
Add instructions for using custom environments
Description
The
Clientclass defaults to using the production environment, but also supports a range of named environments and entirely custom configurations for ad-hoc environments. However, the documentation doesn't reveal how to take advantage of those.This change updates
README.mdto include instructions on using custom environments.Resolves PB-1750.
Docstring & Example Checklist
>>>,...for continuation lines)`Add`)