Bånderapp:library:create
Register a new media library. This tells Baander where to find media files on disk and what type of content to expect. The command runs the same use case as adding a library in the admin panel (POST /api/libraries in the API), with the same validation and the same conflicts.
Quick start
Run from the installed-instance host shell with the dc function from
Getting started. Paths name locations
inside the application container.
dc exec app php bin/console app:library:create 'My Music' /media/library/music music
With a custom slug:
dc exec app php bin/console app:library:create 'My Music' /media/library/music music --slug my-music-collection
Arguments
| Argument | Required | Description |
|---|---|---|
name |
Yes | Human-readable library name |
path |
Yes | Absolute path to the media directory on disk |
type |
Yes | Library type: music, podcast, audiobook, movie, or tv_show |
Options
| Option | Default | Description |
|---|---|---|
--filesystem-type |
local |
Filesystem backend. Currently only local is supported. |
--slug, -s |
Generated from the name | URL-friendly identifier. Omit it to generate one from the name. |
--sort-order |
0 |
Sort order for display (lower numbers appear first) |
--json |
— | Print only the created library in JSON, as the API's data returns it |
Details
Registration accepts all five type names, but the discovery and ingestion path
currently handles only music and movie. Registering another type does not make
it ingestible; its scan fails as unsupported. See
Library management for the supported import path.
The library path must be accessible from inside the app container. If you're using Docker, make sure the directory is mounted as a volume. Check it first with app:library:validate-path.
The slug is used in URLs and API endpoints. If you don't provide one, it's generated from the name (lowercased, with runs of other characters replaced by hyphens). If another library already has the slug, the command creates nothing and fails; provide --slug in that case.
A library's root cannot lie inside another library's root, contain one, or be the same directory, because a file under both would belong to two libraries. The command creates nothing and fails with a message naming the other library; the API answers 409 with reason root_overlaps and the other library's slug in library. Roots are compared by their real paths, so a symlink to another library's directory is refused too, and as written when the directory does not exist yet. Only whole directory names count: /data/music2 sits beside /data/music, not inside it. To split one collection into several libraries, create them on sibling directories, such as /data/music/rock and /data/music/jazz without a library on /data/music.
A library created in the admin panel grants its creating admin access, so that admin receives the notification when a scan of the library completes. The command has no user to grant: nobody receives the library's scan-completed notifications, and users who are not admins do not see it. Admins see and manage every library either way.
Exit codes
| Code | Meaning |
|---|---|
| 0 | Library created |
| 1 | Another library has the slug, or its root overlaps the path, or another error occurred; the message says why |
| 2 | Invalid input, such as an unknown type, a relative path, a malformed slug, a blank name or a sort order that is not a whole number |
Tips
- After creating a library, run app:library:scan to index its contents.
- You can create multiple libraries of the same type (e.g., separate music collections).