Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
9a2a2e6
feat(cli): Add ui5 cache clean command
d3xter666 Jul 17, 2026
09370e9
refactor: Remove stale exports
d3xter666 Jul 20, 2026
53fb381
test: Add test cases
d3xter666 Jul 20, 2026
6dcd54f
fix: Cherry-pick missing methods
d3xter666 Jul 20, 2026
cdc0a74
docs: Update documentation
d3xter666 Jul 20, 2026
2beb71c
docs: Update JSdocs to reflect latest changes
d3xter666 Jul 21, 2026
5778b32
refactor: Rename orphaned dirs to start with underscore
d3xter666 Jul 21, 2026
01825d9
docs: Adjust JSdoc comments
d3xter666 Jul 21, 2026
5b593d9
docs: Update JSDoc
d3xter666 Jul 21, 2026
573495d
fix(cli): Resolve ui5DataDir without shared resolver
d3xter666 Jul 21, 2026
dbd18a1
test(cli): Cover cache ui5DataDir precedence
d3xter666 Jul 21, 2026
eeff300
docs: Adjust documentation
d3xter666 Jul 22, 2026
f3f317a
refactor: Align cleaners on common API
d3xter666 Jul 22, 2026
d8ebb21
docs: Adjust Troubleshooting cleanup section
d3xter666 Jul 22, 2026
c2afd62
refactor: DRY cleanups
d3xter666 Jul 22, 2026
63838f1
test: Add more test cases
d3xter666 Jul 22, 2026
cbe1bd0
refactor: Comment stale invocations
d3xter666 Jul 22, 2026
7e71d08
test: Fix missed stubs
d3xter666 Jul 22, 2026
cf82481
fix: Address potential race condition during dir rename
d3xter666 Jul 22, 2026
e3f3c4f
refactor: Long running Db cleanup
d3xter666 Jul 22, 2026
aa8806b
refactor: Optimize Db Vacuum
d3xter666 Jul 22, 2026
9e59f1b
refactor: Cleanups and UX alignment
d3xter666 Jul 22, 2026
298e23d
test: Improve coverage
d3xter666 Jul 22, 2026
f74804c
docs: Update docs
d3xter666 Jul 22, 2026
97e24d4
refactor: Remove redundant code
d3xter666 Jul 22, 2026
4b5e258
fix: Minor Bugs
d3xter666 Jul 23, 2026
6a3ccc1
fix: ESLint issues
d3xter666 Jul 23, 2026
a18397a
refactor: Return statements
d3xter666 Jul 23, 2026
f4a25d5
docs: Fix JSDoc comments
d3xter666 Jul 23, 2026
59c37f4
feat: Add usage warning for cache clean command
d3xter666 Jul 23, 2026
06dd017
refactor: Rename "orphaned" to "stale"
d3xter666 Jul 27, 2026
227c115
refactor: Group cache messages into Active & Stale groups
d3xter666 Jul 27, 2026
524283b
fix: ESLint issues
d3xter666 Jul 27, 2026
e664eec
refactor: DRY for data tables
d3xter666 Jul 28, 2026
bc3d34d
refactor: Consolidate common logic in CacheManager
d3xter666 Jul 28, 2026
5e0fc2b
refactor: Export cache clean modules for internal (@ui5/cli) usage
d3xter666 Jul 28, 2026
cdaec3b
refactor: Rename ambiguous const
d3xter666 Jul 28, 2026
a5a714e
revert: Bad renaming
d3xter666 Jul 28, 2026
6b89923
test: Fix failing tests
d3xter666 Jul 28, 2026
8f195c8
build: Update package-lock
d3xter666 Jul 28, 2026
90c1263
refactor: Remove redundant check
d3xter666 Jul 28, 2026
9fb4993
refactor: Provide complete path of the internal exports
d3xter666 Jul 29, 2026
948dd6d
refactor: Rename --yes flag to --force
d3xter666 Jul 29, 2026
46db12d
fix: ESLint findings
d3xter666 Jul 29, 2026
34ae040
feat: Enable detailed output only in verbose mode
d3xter666 Jul 29, 2026
79e7401
refactor: Reword confirmation prompt
d3xter666 Jul 29, 2026
04c5e9e
fix: Do not report wrongly stale cache
d3xter666 Jul 29, 2026
af83085
fix: Defensive logging for parallel executions
d3xter666 Jul 29, 2026
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
35 changes: 25 additions & 10 deletions internal/documentation/docs/pages/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,43 @@ UI5 CLI stores several kinds of data under your user's home directory in `~/.ui5
| `~/.ui5/buildCache/` | Build cache used by `ui5 build` and `ui5 serve` (see [Build Cache Control](./Builder.md#build-cache-control)) | Yes — rebuilt on next `ui5 build` / `ui5 serve` |
| `~/.ui5/server/` | Locally generated SSL certificate and private key for HTTPS / HTTP/2 mode | Yes — regenerated on next HTTPS server start; the new certificate must be re-trusted |

::: warning
Only remove these directories when no UI5 CLI process and no `@ui5/*` API consumer is actively running. Deleting files that are in use can cause running builds or servers to fail or produce inconsistent results.
:::

#### Resolution

To free disk space, remove the relevant subdirectory.
Use the dedicated cache clean command, which removes all cached data:

```sh
ui5 cache clean
```

To only remove framework downloads:
For a detailed preview and grouped cleanup summary, use the `--verbose` flag:

```sh
rm -rf ~/.ui5/framework/
ui5 cache clean --verbose
```

To only remove the build cache:
To skip the confirmation prompt (for example in CI environments), use the `--force` flag.
In non-verbose mode with `--force`, the command runs completely silent:

```sh
rm -rf ~/.ui5/buildCache/
ui5 cache clean --force
```

The command removes the following cached data:
- **UI5 Framework packages** — downloaded UI5 library files (`~/.ui5/framework/`)
- **Build cache** — build data (`~/.ui5/buildCache/`)

If a previous `ui5 cache clean` was interrupted (e.g. process killed or system crash), the command also detects and removes any leftover data from that interrupted operation, listed as separate entries:
- **Stale UI5 Framework packages** — incomplete framework directories left over from a previously interrupted cleanup (`~/.ui5/_framework_to_delete_*/`)
- **Stale build cache** — freed database pages not yet reclaimed during a previously interrupted cleanup

Any required framework dependencies will be re-downloaded during the next UI5 CLI invocation.

::: info
If you have configured a custom data directory via `UI5_DATA_DIR` or `ui5 config set ui5DataDir`, replace `~/.ui5/` with that path. See [Changing UI5 CLI's Data Directory](#changing-ui5-cli-s-data-directory).
If you have configured a custom data directory via `UI5_DATA_DIR` or `ui5 config set ui5DataDir`, the `ui5 cache clean` command will clean up that location instead of the default `~/.ui5/`. See [Changing UI5 CLI's Data Directory](#changing-ui5-cli-s-data-directory).
:::

::: warning
Only remove these directories, or run `ui5 cache clean`, when no UI5 CLI process and no `@ui5/*` API consumer is actively running. Running `ui5 cache clean` while `ui5 build` or `ui5 serve` is in progress can break the running process and lead to failed or inconsistent results.
Comment thread
d3xter666 marked this conversation as resolved.
:::

## Environment Variables
Expand Down
Loading
Loading