TypekitCli
A command line interface in Ruby to fetch information about your kits using the public Typekit APIs.
Installation
Add this line to your application's Gemfile:
gem 'typekit-cli'
And then execute:
$ bundle
Or install it yourself as:
$ gem install typekit-cli
Authentication
Some API endpoints require authentication - for example, editing a kit or viewing private information such as a list of kits owned by a user. Other endpoints will give extra information when authenticated. To authenticate as a user you need to pass a token to the API.
You can support your TypeKit token through an environment variable:
exports TYPEKIT_TOKEN = your_typekit_api_token
typekit kits
Otherwise you need to pass a token inline:
typekit kits token your_typekit_api_token
Or with a shortcut:
typekit kits -t your_typekit_api_token
Usage and supported commands
typekit help
typekit kits
typekit kit KIT_ID
Development
After checking out the repo, run bin/setup
to install dependencies. Then, 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
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/blackbumer/typekit_cli/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License
Released under the MIT License. See the LICENSE file for further details.