Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abtris/bee
Simple unofficial Apiary CLI client in Golang
https://github.com/abtris/bee
Last synced: about 1 month ago
JSON representation
Simple unofficial Apiary CLI client in Golang
- Host: GitHub
- URL: https://github.com/abtris/bee
- Owner: abtris
- License: mit
- Created: 2016-06-10T10:27:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T06:50:50.000Z (5 months ago)
- Last Synced: 2024-06-20T00:28:32.025Z (5 months ago)
- Language: Go
- Homepage:
- Size: 110 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://travis-ci.org/abtris/bee)
# Bee
Bee is a command line tool for publishing and fetching existing documents from Apiary.io.
## Install
Need golang 1.11+ - deps using go modules
```
go get github.com/abtris/bee
```
or binary downloads:
### Mac
```
wget https://github.com/abtris/bee/releases/download/1.0.0/bee-darwin-amd64 -O /usr/local/bin/bee
chmod +x /usr/local/bin/bee
```
### Linux
```
wget https://github.com/abtris/bee/releases/download/1.0.0/bee-linux-amd64 -O /usr/local/bin/bee
chmod +x /usr/local/bin/bee
```
### Windows
Just [download file](https://github.com/abtris/bee/releases/download/1.0.0/bee-windows-amd64) and make executable (add `.exe`).
## Config File
In order to fetch and publish documentation, you will need to generate an authentication token by going to [https://login.apiary.io/tokens](https://login.apiary.io/tokens). Keep this token safe, because a token is like a password and will give anyone with this token access to fetch and publish to your documentation.
`~/.bee.yaml`
```yaml
APIARY_API_KEY: XXXXXXXXXXXXXX
```
## Usage
```
bee fetch
```
or
```
bee publish filename
```
## Debug - using proxy as [Charles](https://www.charlesproxy.com/)
HTTP_PROXY=http://127.0.0.1:8888 bee fetch
# Release
You need use [goreleaser](https://goreleaser.com/). For work need GITHUB_TOKEN with repo scope and installed goreleaser.
For release with Github Actions you need just tag.
```
git checkout master
git tag -a v1.1.1 -m "Release 1.1.1"
git push --tags
```
## License
MIT