Skip to content

Commit b1ee47d

Browse files
JesseColazchohfi
andauthored
Add docs about Global Cache Directory (#168)
Add docs about Global Cache Directory Inspired by issue #120 --------- Co-authored-by: JesseCol <[email protected]> Co-authored-by: Alexandre Zollinger Chohfi <[email protected]>
1 parent b1fca19 commit b1ee47d

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/usage.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ winapp init [base-directory] [options]
3030
- Creates development certificate and AppxManifest.xml
3131
- Sets up build tools and enables developer mode
3232
- Updates .gitignore to exclude generated files
33+
- Stores sharable files in the global cache directory
3334

3435
**Examples:**
3536

@@ -63,6 +64,7 @@ winapp restore [options]
6364
- Reads existing `winapp.yaml` configuration
6465
- Downloads/updates SDK packages to specified versions
6566
- Regenerates C++/WinRT headers and binaries
67+
- Stores sharable files in the global cache directory
6668

6769
**Examples:**
6870

@@ -425,3 +427,27 @@ All commands support these global options:
425427
- `--verbose`, `-v` - Enable verbose output for detailed logging
426428
- `--quiet`, `-q` - Suppress progress messages
427429
- `--help`, `-h` - Show command help
430+
431+
---
432+
433+
### Global Cache Directory
434+
435+
Winapp creates a directory to cache files that can be shared between multiple projects.
436+
437+
By default, winapp creates a directory at `$UserProfile/.winapp` as the global cache directory.
438+
439+
To use a different location, set the `WINAPP_CLI_CACHE_DIRECTORY` environment variable.
440+
441+
In **cmd**:
442+
```cmd
443+
REM Set a custom location for winapp's global cache
444+
set WINAPP_CLI_CACHE_DIRECTORY=d:\temp\.winapp
445+
```
446+
447+
In **Powershell** and **pwsh**:
448+
```pwsh
449+
# Set a custom location for winapp's global cache
450+
$env:WINAPP_CLI_CACHE_DIRECTORY=d:\temp\.winapp
451+
```
452+
453+
Winapp will create this directory automatically when you run commands like `init` or `restore`.

0 commit comments

Comments
 (0)