https://github.com/malinskiy/stf-client

Request devices from Smartphone Test Farm for adb connection
https://github.com/malinskiy/stf-client

adb android openstf

Last synced: 3 days ago
JSON representation

Request devices from Smartphone Test Farm for adb connection

• Host: GitHub
• URL: https://github.com/malinskiy/stf-client
• Owner: Malinskiy
• License: mit
• Created: 2016-07-28T08:06:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-20T20:38:07.000Z (over 2 years ago)
• Last Synced: 2024-12-15T15:11:22.005Z (7 days ago)
• Topics: adb, android, openstf
• Language: Ruby
• Size: 77.1 KB
• Stars: 55
• Watchers: 6
• Forks: 13
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/Malinskiy/stf-client.svg?branch=master)](https://travis-ci.org/Malinskiy/stf-client)

[![Gem](https://img.shields.io/gem/v/stf-client.svg)](https://rubygems.org/gems/stf-client)

[![Gem](https://img.shields.io/gem/dt/stf-client.svg)](https://rubygems.org/gems/stf-client)

# Stf::Client

Automation client for connecting to [OpenSTF](https://github.com/openstf/stf) devices.

Designed with the following scenario in mind:

1. Connect to remote devices

2. Do something with the device via adb (Instrumentation Test, adb install, etc)

3. Disconnect from device

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'stf-client'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install stf-client

## Usage

```

NAME

    stf-client - Smartphone Test Lab client

SYNOPSIS

    stf-client [global options] command [command options] [arguments...]

GLOBAL OPTIONS

    --help             - Show this message

    -t, --token=arg    - Authorization token, can also be set by environment variable STF_TOKEN (default: none)

    -u, --url=arg      - URL to STF, can also be set by environment variable STF_URL (default: none)

    -v, --[no-]verbose - Be verbose

COMMANDS

    clean      - Frees all devices that are assigned to current user in STF. Doesn't modify local adb

    connect    - Search for a device available in STF and attach it to local adb server

    disconnect - Disconnect device(s) from local adb server and remove device(s) from user devices in STF

    help       - Shows a list of commands or help for one command

    keys       - Show available keys for filtering

    values     - Show known values for the filtering key

    

ENVIRONMENT VARIABLES

    STF_TOKEN - Authorization token 

    STF_URL   - URL to STF 

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Malinskiy/stf-client.

## License

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