Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChristophWurst/krankerl
A CLI helper to manage, package and publish Nextcloud apps
https://github.com/ChristophWurst/krankerl
cli nextcloud rust tooling
Last synced: 3 months ago
JSON representation
A CLI helper to manage, package and publish Nextcloud apps
- Host: GitHub
- URL: https://github.com/ChristophWurst/krankerl
- Owner: ChristophWurst
- License: gpl-3.0
- Created: 2017-09-13T17:38:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T02:09:59.000Z (10 months ago)
- Last Synced: 2024-04-09T12:06:09.870Z (7 months ago)
- Topics: cli, nextcloud, rust, tooling
- Language: Rust
- Homepage:
- Size: 3.68 MB
- Stars: 32
- Watchers: 4
- Forks: 5
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Krankerl
[](https://crates.io/crates/krankerl)
[](https://crates.io/crates/krankerl)
[](https://aur.archlinux.org/packages/krankerl/)
A CLI helper to manage [Nextcloud](https://nextcloud.com/) apps.
## Installation
* [Arch Linux](https://aur.archlinux.org/packages/krankerl-bin/)
* [Arch Linux (source build)](https://aur.archlinux.org/packages/krankerl)
* [Debian and derivatives](https://github.com/ChristophWurst/krankerl/releases)
* [Linux (generic)](https://github.com/ChristophWurst/krankerl/releases)
### Source build
You can build the application from source with the help of [Cargo](https://doc.rust-lang.org/cargo/)
```
cargo install --git https://github.com/ChristophWurst/krankerl
```
[More info about Cargo install](https://doc.rust-lang.org/cargo/commands/cargo-install.html)
## Usage
```
Usage:
krankerl clean
krankerl enable
krankerl disable
krankerl init
krankerl login (--appstore | --github)
krankerl package [--shipped]
krankerl publish [--nightly]
krankerl sign --package
krankerl up
krankerl version (major|minor|patch)
krankerl --version
Options:
-h --help Show this screen.
--version Show version.
```
In case you wondered about the app's name: the word *Krankerl* means *tendril*
in Lower Austrian dialect. [This](https://www.instagram.com/p/BatDv1DhhOe/)
is what that typically looks like in a vine yard.
## Enable the current app
Krankerl provides a shortcut to enable an app via the `occ` tool. This assumes
that you are inside the app's root directory and `occ` can be found in the directory
two levels above the current one.
```bash
krankerl enable
```
## Disable the current app
Krankerl provides a shortcut to disable an app via the `occ` tool. This assumes
that you are inside the app's root directory and `occ` can be found in the directory
two levels above the current one.
```bash
krankerl disable
```
## Packaging
Krankerl can build a `.tar.gz` archive for the current app. This assumes a
`krankerl.toml` configuration file to exist in the app's root directory. If
it doesn't, Krankerl will fall back to sensible defaults.
The command will not use the current state of the app directory, but
clone it into a new directory. This step was added to make app builds
reproducible and independent of local changes.
### Steps
These are the steps Krankerl executes to package an app:
* Delete `build/artifacts` if it exists
* Clone current directory to `build/artifacts/`
* Run pre-packaging commands
* Build list of files and directories that are not excluded by `.nextcloudignore`
* Pack and compress those files and directories into a `build/artifacts/.tar.gz` archive
### Initialize configuration
You can either manually create the `krankerl.toml` config file or have Krankerl
create it for you by using the `init` command:
```bash
krankerl init
```
This will create a minimal configuration. Adjust it to your needs.
### Configuration overview
#### Excluded files
To exclude files from packaging, commit a `.nextcloudignore` that matches all directories
and files to exclude. The syntax is the one of a gitignore.
#### Pre-package commands
Building app archives often requires execution of a few commands. Common
examples for that are composer and npm dependencies that are not part of
the git repository and thus are missing in the cloned directory.
The `package_cmds` array will let you specify commands that are executed
by `sh` in the app's root directory.
```toml
[package]
before_cmds = [
"composer install",
"npm install",
"npm run build",
]
```
## Publish
Krankerl allows you to publish an app release on [apps.nextcloud.com](https://apps.nextcloud.com)
once you've packaged the app files with the `package` command.
Note: This currently only includes the registration on the app store. You have to
first upload the archive to GitHub (or any download server) and then pass
the URL to the `package` command:
```bash
krankerl publish --nightly https://github.com/ChristophWurst/nextcloud_sentry/releases/download/nightly-20171126/sentry.tar.gz
```
The `--nightly` switch registers the app as nightly release.