abra/README.md

61 lines
2.0 KiB
Markdown
Raw Normal View History

2020-09-08 06:54:07 +00:00
# abra
2020-09-07 21:29:29 +00:00
2020-10-25 20:08:03 +00:00
[![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/abra/status.svg)](https://drone.autonomic.zone/coop-cloud/abra)
2020-10-26 10:49:06 +00:00
[![codecov](https://codecov.io/gh/Autonomic-Cooperative/abra/branch/main/graph/badge.svg?token=aX3I5NMRsj)](undefined)
2020-09-08 06:54:19 +00:00
2020-10-25 20:22:29 +00:00
> https://cloud.autonomic.zone
2020-10-26 17:16:54 +00:00
The cooperative cloud utility belt 🎩🐇
`abra` is a command-line tool for managing your own [Co-op Cloud](https://cloud.autonomic.zone). It can provision new servers, create applications, deploy them, run backup and restore operations and a whole lot of other things. It is the go-to tool for day-to-day operations when managing a Co-op Cloud instance.
2021-03-04 12:24:13 +00:00
## Change log
See [CHANGELOG.md](./CHANGELOG.md).
2020-12-29 14:10:05 +00:00
## Documentation
> [docs.cloud.autonomic.zone](https://docs.cloud.autonomic.zone/)
2020-09-22 11:05:23 +00:00
## Install
2020-09-08 18:10:26 +00:00
Install the latest stable release:
2020-09-22 11:05:23 +00:00
```sh
2020-10-25 20:08:03 +00:00
curl https://install.abra.autonomic.zone | bash
2020-09-22 11:05:23 +00:00
```
or the bleeding-edge development version:
```sh
curl https://install.abra.autonomic.zone | bash -s -- --dev
```
2021-03-04 15:31:18 +00:00
The source for this script is [here](./installer/installer).
## Update
Run `abra upgrade` to automatically download and install the latest release
2021-03-16 06:00:23 +00:00
version.
To update the development version, run `abra upgrade --dev`.
## Hack
2021-03-17 11:50:02 +00:00
It's written in Bash version 4 or greater!
Install it via `curl https://install.abra.autonomic.zone | bash -s -- --dev`, then you can hack on the source in `~/.abra/src`.
The command-line interface is generated via [docopt](http://docopt.org/). If you add arguments then you need to run `make docopt` ro regenerate the parser.
2021-03-15 09:07:17 +00:00
Please remember to update the [CHANGELOG](./CHANGELOG.md) when you make a change.
2021-03-17 11:59:09 +00:00
## Release
- Change the `x.x.x` header in [CHANGELOG.md](./CHANGELOG.md) to reflect new version and mark date
- Update versions in [installer/installer](./installer/installer) and [abra](./abra)
- `git commit` the above changes and then tag it with `git tag <your-new-version>`
- Then `git push` and `git push --tags`
- Deploy a new installer script `make release-installer`
- Tell the world