Skip to content

katzer/orbit

Repository files navigation

orbit - The Command-Line Interface for Orbit
GitHub release (latest by date) Build Status Build status Maintainability

$ orbit -h

Usage: orbit [category] [options...] matchers...
Categories:
find                      Query infos
exec "COMMAND"            Run command
exec job "JOB"            Run job
exec script "PATH"        Run script
upload "SOURCE" "TARGET"  Upload file
download "SOURCE"         Download file
web start                 Start web app
web stop                  Stop web app
docker build              Build container
docker start              Start container
docker stop               Stop container
export "PATH"             Convert KDB file
env                       Show env vars
help                      Print this text
version                   Show version number

Installation

Download the latest version from the release page and add the executable to your PATH.

Usage

Run a sql script on a database:

$ orbit exec script "path/to/script.sql" type=db@tags:ora11

Execute a command on a server:

$ orbit exec "hostname" -p type=server

Download a file from a server:

$ orbit download "remote/file/path" -l "local/file/path" app-package-1 app-package-2

Start web app from inside a docker container:

$ orbit docker start

Note: $ORBIT_HOME/docker_compose.yml takes precedence over $ORBIT_HOME/Dockerfile.yml.

Development

Clone the repo:

$ git clone https://github.com/katzer/orbit.git && cd orbit/

Install the dependencies:

$ bundle

And then execute:

$ rake compile

To compile the sources locally for the host machine only:

$ MRUBY_CLI_LOCAL=1 rake compile

You'll be able to find the binaries in the following directories:

  • Linux (64-bit Musl): build/x86_64-alpine-linux-musl/bin/orbit
  • Linux (64-bit GNU): build/x86_64-pc-linux-gnu/bin/orbit
  • Linux (64-bit, for old distros): build/x86_64-pc-linux-gnu-glibc-2.9/bin/orbit
  • OS X (64-bit): build/x86_64-apple-darwin17/bin/orbit
  • Windows (64-bit): build/x86_64-w64-mingw32/bin/orbit
  • Host: build/host/bin/orbit

For the complete list of build tasks:

$ rake -T

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/katzer/orbit.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

The code is available as open source under the terms of the Apache 2.0 License.

Made with ❤️ in Leipzig

© 2016 appPlant GmbH