@@ 15,20 15,25 @@ You can use the help command to view a command description
cabin
```
-> Simple alpine package builder with dependency resolution using abuild
-> Usage: cabin <COMMAND>
-> Commands:
-> list Lists all known packages
-> scan Rescans all folders
-> build-all Build all packages in repo
-> build Builds the package
-> info Displays package information
-> search Searches the database for a package with the name or containing the name
-> tree show a list of all dependencies
-> help Print this message or the help of the given subcommand(s)
-> Options:
-> -h, --help Print help
-> -V, --version Print version
+```
+Simple alpine package builder with dependency resolution using abuild
+
+Usage: cabin <COMMAND>
+
+Commands:
+ list Lists all known packages
+ scan Rescans all folders
+ build-all Build all packages in repo
+ build Builds the package
+ info Displays package information
+ search Searches the database for a package with the name or containing the name
+ tree show a list of all dependencies
+ help Print this message or the help of the given subcommand(s)
+
+Options:
+ -h, --help Print help
+ -V, --version Print version
+```
You can also combine the commands with
`help` to view available options
@@ 48,13 53,18 @@ cabin scan
cabin help scan
```
-> Searches the folder for APKBUILDs recursively and builds a local database
-> Usage: cabin scan [FOLDER] [DB]
-> Arguments:
-> [FOLDER] workspace
-> [DB] package database path
-> Options:
-> -h, --help Print help
+```
+Searches the folder for APKBUILDs recursively and builds a local database
+
+Usage: cabin scan [FOLDER] [DB]
+
+Arguments:
+ [FOLDER] workspace
+ [DB] package database path
+
+Options:
+ -h, --help Print help
+```
**NOTE**: you have to rerun the `scan` command
every time the `aports` change.
@@ 70,11 80,15 @@ For a list of all options, see the help page
cabin help list
```
-> Lists all known packages
-> Usage: cabin list [OPTIONS]
-> Options:
-> -d, --db <DB> package database path
-> -h, --help Print help
+```
+Lists all known packages
+
+Usage: cabin list [OPTIONS]
+
+Options:
+ -d, --db <DB> package database path
+ -h, --help Print help
+```
### Search
```sh
@@ 85,13 99,18 @@ Search through package names, descriptions and urls and lists package names,vers
```sh
cabin help search
```
-> Searches the database for a package with the name or containing the name
-> Usage: cabin search [OPTIONS] <QUERY>
-> Arguments:
-> <QUERY> search query
-> Options:
-> -d, --db <DB> package database path
-> -h, --help Print help
+```
+Searches the database for a package with the name or containing the name
+
+Usage: cabin search [OPTIONS] <QUERY>
+
+Arguments:
+ <QUERY> search query
+
+Options:
+ -d, --db <DB> package database path
+ -h, --help Print help
+```
### Build
@@ 108,29 127,38 @@ if you want to use the dependency resolution / auto build feature.
cabin help build
```
-> Builds the package
-> Usage: cabin build [OPTIONS] <PACKAGE>
-> Arguments:
-> <PACKAGE> the packagename
-> Options:
-> -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
-> -r disables dependency resolution wont compile the dependencies locally however this will still pass -r to abuild and fetch the prebuild packages from upstream
-> -d, --db <DB> package database path
-> -v allows the build log to be toggled on and off
-> -h, --help Print help
+```
+Builds the package
+
+Usage: cabin build [OPTIONS] <PACKAGE>
+
+Arguments:
+ <PACKAGE> the packagename
+
+Options:
+ -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
+ -r disables dependency resolution wont compile the dependencies locally however this will still pass -r to abuild and fetch the prebuild packages from upstream
+ -d, --db <DB> package database path
+ -v allows the build log to be toggled on and off
+ -h, --help Print help
+```
### Build All
```sh
cabin help build-all
```
-> Build all packages in repo
-> Usage: cabin build-all [OPTIONS]
-> Options:
-> -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
-> -d, --db <DB> package database path
-> -v allows the build log to be toggled on and off
-> -h, --help Print help
+```
+Build all packages in repo
+
+Usage: cabin build-all [OPTIONS]
+
+Options:
+ -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
+ -d, --db <DB> package database path
+ -v allows the build log to be toggled on and off
+ -h, --help Print help
+```
### Build Group
Allows building multiple packages in topologically sorted order.
@@ 138,15 166,20 @@ Allows building multiple packages in topologically sorted order.
cabin build-group [...packages]
```
-> Builds multiple packages from a list
-> Usage: cabin build-group [OPTIONS] [PACKAGES]...
-> Arguments:
-> [PACKAGES]... list of packages to be build
-> Options:
-> -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
-> -d, --db <DB> package database path
-> -v allows the build log to be toggled on and off
-> -h, --help Print help
+```
+Builds multiple packages from a list
+
+Usage: cabin build-group [OPTIONS] [PACKAGES]...
+
+Arguments:
+ [PACKAGES]... list of packages to be build
+
+Options:
+ -a, --arch <ARCH> build the package for a target architecture requires abuild-rootbld and qemu-binfmt to be installed (for the given architecture) and the .rootbld-repositories file to be configured correctly (even if set to host architecture)
+ -d, --db <DB> package database path
+ -v allows the build log to be toggled on and off
+ -h, --help Print help
+```
### Tree
@@ 154,14 187,19 @@ cabin build-group [...packages]
cabin help tree
```
-> show a list of all dependencies
-> Usage: cabin tree [OPTIONS] <PACKAGE>
-> Arguments:
-> <PACKAGE> the packagename
-> Options:
-> -d, --db <DB> package database path
-> -l shows only local dependencies, that can be found in the local database will also topologically sort the dependencies
-> -h, --help Print help
+```
+show a list of all dependencies
+
+Usage: cabin tree [OPTIONS] <PACKAGE>
+
+Arguments:
+ <PACKAGE> the packagename
+
+Options:
+ -d, --db <DB> package database path
+ -l shows only local dependencies, that can be found in the local database will also topologically sort the dependencies
+ -h, --help Print help
+```
## Dependencies
### Compile-time