Skip to content

Commit 4bc2bfb

Browse files
committed
Add shadowenv prompt-widget mention to docs
1 parent 73b0eb6 commit 4bc2bfb

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/best-practices.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,9 @@ a locally-generated artifact and be generated entirely by user tooling. At Shopi
3939

4040
This is not the only valid way to go though, you may get some mileage out of committing the files.
4141
Let us know what you do!
42+
43+
## Propmt Widget
44+
45+
You may find it helpful to have a visual indicator in your terminal that a
46+
Shadowenv is active. You can embed `$(shadowenv prompt-widget)` in your `PS1` or
47+
`PROMPT`, etc., to achieve this.

docs/getting-started.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,16 @@ shadowenv exec -- nginx -g 'daemon off;'
132132

133133
In this case, we didn't need to load the Shadowenv shell hook, as `shadowenv exec` loaded the
134134
environments before executing nginx.
135+
136+
# Nested Shadowenvs
137+
138+
Shadowenv supports nested environments. In order for a shadowenv to inherit from
139+
another shadowenv further up the path, create a symlink at
140+
`.shadowenv.d/parent` to the higher `.shadowenv.d`. For example:
141+
142+
```
143+
ln -s /a/.shadowenv.d /a/b/c/.shadowenv.d/parent
144+
```
145+
146+
When this is done, shadowlisp files in `a` will be evaluated before those in
147+
`c`.

0 commit comments

Comments
 (0)