https://github.com/infinum/shaman

CLI for deploying builds to Tryoutapps.com
https://github.com/infinum/shaman

ruby

Last synced: 11 months ago
JSON representation

CLI for deploying builds to Tryoutapps.com

• Host: GitHub
• URL: https://github.com/infinum/shaman
• Owner: infinum
• License: mit
• Created: 2021-02-08T13:59:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T12:49:32.000Z (about 2 years ago)
• Last Synced: 2025-07-28T22:48:15.324Z (11 months ago)
• Topics: ruby
• Language: Ruby
• Homepage:
• Size: 1.67 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Gem Version](https://badge.fury.io/rb/shaman_cli.svg)](https://badge.fury.io/rb/shaman_cli)

# Shaman

CLI for deploying builds to Tryoutapps.com

## Installation

Install it yourself as:

    $ gem install shaman_cli

Get your user token from `https://[TENANT].tryoutapps.com/users/me` and export it to environment variable `SHAMAN_TOKEN`.

    export SHAMAN_TOKEN=infnweoinfwi32r23jr2309j

Export your Tryoutapps tenant URL to the environement variable `SERVER_URL`

    export SERVER_URL=https://[TENANT].tryoutapps.com

## Usage

First make sure that you have created your `project` and the desired `environment` on you Tryoutapps tenant. This will allow you to see all your tenant independent projects in the shaman init prompt.

### Init

    $ shaman init

    Initialize your project

    Options:

      -s, --search STRING  Shrink project selection

      -f, --favorites      Show only favorites

      -p, --platform PLATFORM Choose platform

      -i, --project_id PROJECT Choose project id

Example of `.shaman.yml`

      ---

      production:

        :release_path: spec/files/test.ipa

        :token: Hu6vuqgEF3FzrmenDQ1kk86R

Explanation:

`release_path`      - this is the path to the release file

`token`             - This is the environment token for communicating with API

### Deploy

This will deploy your relese file to labs with with configs from .shaman.yml

    $ shaman deploy

    $ shaman deploy [environment]

    Deploy a release to specified environment

    Options:

      -m, --message MESSAGE             Changelog message

      -f, --file FILE                   Release path

      -t, --token TOKEN                 Use different user token

      -c, --config FILE                 Use different config file

      -g, --git                         Use git for message (overrides any manual settings!)

      -C, --commit COMMIT               Which commit to use instead of HEAD

      -n, --release_name RELEASE_NAME   Release name (ZIP platform only)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.

You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update

the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for

the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).