Skip to content

[docs] Update documentation for features from 2026-03-26 #461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielmeppiel wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[docs] Update documentation for features from 2026-03-26 #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff65c99
docs: update docs for batch bug fixes from #456
Mar 26, 2026
3442455
Apply suggestions from code review
danielmeppiel Mar 27, 2026
b27df82
docs: fix installation troubleshooting section
Copilot Mar 27, 2026
52541ea
docs: fix glibc troubleshooting -- generic version, devcontainer guid…
Copilot Mar 27, 2026
1b665aa
Merge branch 'main' into docs/update-for-456-batch-fixes-91bccf8a1df4…
danielmeppiel Mar 30, 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
21 changes: 21 additions & 0 deletions docs/src/content/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,27 @@ mkdir -p ~/bin
# then install the binary to ~/bin/apm and add ~/bin to PATH
```

### Binary install fails on older Linux (devcontainers, Debian-based images)

On systems with a glibc version older than what the pre-built binary requires, the
binary will fail to run. This commonly affects Debian Bookworm-based devcontainers
(glibc 2.36) since the binary is built on Ubuntu 24.04 (glibc 2.39). The installer
automatically detects incompatible glibc versions and falls back to
`pip install --user apm-cli`.

This installs the `apm` command into your user `bin` directory (commonly `~/.local/bin`).
If `apm` is not found after installation, ensure that this directory is on your `PATH`.

**Recommended fix for devcontainers:** switch your base image from `bookworm` to
`trixie` (e.g., `mcr.microsoft.com/devcontainers/universal:24-trixie`), which ships
glibc 2.40+ and runs the pre-built binary directly.

If you prefer to install via pip directly:

```bash
pip install --user apm-cli
```

### Authentication errors when installing packages

See [Authentication -- Troubleshooting](../authentication/#troubleshooting) for token setup, SSO authorization, and diagnosing auth failures.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/reference/lockfile-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The lock file serves four goals:
| Event | Effect on `apm.lock.yaml` |
|-------|----------------------|
| `apm install` (first run) | Created. All dependencies resolved, commits pinned, files recorded. |
| `apm install` (subsequent) | Read. Locked commits reused. New dependencies appended. |
| `apm install` (subsequent) | Read. Locked commits reused. New dependencies appended. File only written when semantic content changes (dependencies, MCP servers/configs, `lockfile_version`); no churn from `generated_at` or `apm_version` fields. |
| `apm install --update` | Re-resolved. All refs re-resolved to latest matching commits. |
| `apm deps update` | Re-resolved. Refreshes versions for specified or all dependencies. |
| `apm pack` | Enriched. A `pack:` section is prepended to the bundled copy (see [section 6](#6-pack-enrichment)). |
Expand Down
Loading