Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halestudio/hale-cli
hale command line interface
https://github.com/halestudio/hale-cli
Last synced: 2 months ago
JSON representation
hale command line interface
- Host: GitHub
- URL: https://github.com/halestudio/hale-cli
- Owner: halestudio
- License: lgpl-3.0
- Created: 2016-07-02T08:46:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T11:26:37.000Z (8 months ago)
- Last Synced: 2024-05-22T12:37:11.676Z (8 months ago)
- Language: Groovy
- Homepage:
- Size: 477 KB
- Stars: 1
- Watchers: 3
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
hale-cli
========
[](https://hub.docker.com/r/wetransform/hale-cli/)
hale command line interface.
Lists available commands when run without arguments.
From version 6 onwards hale-cli is based on [hale-core](https://github.com/halestudio/hale-core). The version of hale-cli does not necessarily resemble the version of the hale-core dependencies used.
Here you can find an overview on which version of hale-core is used:
| hale-cli | hale-core (major version) | Java
|----------|---------------------------| ----
| 6.x | 6 | 17
Earlier versions of hale-cli were based on [hale»studio](https://github.com/halestudio/hale) dependencies.
Here you can find an overview on which hale»studio version is used:
| hale-cli | hale»studio (major version) | Java
| -------- | --------------------------- | ----
| 5.x | 5 | 17
| 4.x | 4 | 8
| 3.x | 3 | 8
Build
-----
Build distribution archive:
```
./gradlew distZip
```
Build Debian package:
```
./gradlew buildDeb
```
Build docker image:
```
./gradlew dockerBuildImage
```
Run
---
You can run the application using Gradle.
```
./gradlew run
```
Alternatively, you can run the start script of the built application.
```
hale --version
```
You can provide arguments to run as string in `""` following the below syntax.
For example pass argument `help` to run command as below
```
./gradlew run --args="help"
```
If using `./gradlew installDist`, the start script can be found in `./build/install/hale/bin/`.
JVM parameters can be provided to the start script with the `HALE_OPTS` environment variable.
Configuration
-------------
### Logging
The system properties `log.hale.level` and `log.root.level` can be set to control the default logging levels.
```
HALE_OPTS="-Dlog.hale.level=INFO -Dlog.root.level=WARN"
```
### Proxy connection
If you need to connect to the internet via a proxy server, you need to provide that information as system properties as well.
The following system properties can be provided to configure the proxy:
* `http.proxyHost` - the proxy host name or IP address
* `http.proxyPort` - the proxy port number
* `http.nonProxyHosts` - hosts for which the proxy should not be used, separated by | (optional)
* `http.proxyUser` - user name for authentication with the proxy (optional)
* `http.proxyPassword` - password for authentication with the proxy (optional)
Example:
```
HALE_OPTS="-Dhttp.proxyHost=webcache.example.com -Dhttp.proxyPort=8080 -Dhttp.nonProxyHosts='localhost|host.example.com'"
```
### Language
Some commands may produce different results based on your language.
By default the system language is used.
You can override the default locale settings via the following system properties:
* `user.language` - two letter code for the language (e.g. `de`)
* `user.country` - two letter code for the country (e.g. `DE`)
* `user.variant` - name of the variant, if applicable
Example:
```
HALE_OPTS="-Duser.country=DE -Duser.language=de"
```
Helpers
-------
Check which files were installed by the `.deb` package:
```
dpkg-query -L hale-cli
```