Giter Site home page Giter Site logo

stack-cli's Introduction

Stackrecord v200 (Release 15/01/2016)

Stackrecord is Github based changelog repository API built for developers to keep changes of their project releases. We offer a free accounts for all solo developers and freelancers. You can read more about Stackrecord on our official website.

Stack-CLI

Stackrecord official repository for our CLI (Command Line Interface) that connects directly to our [API](Stackrecord v1) made in Ruby. The tool is open-source and currently in beta. You can also use this tool to learn how our API work. The full documentation of our API is located here. Stack-CLI is based on our sister-project also made by Stackrecord for offline release note generation Vicilog.

How it works

Our CLI is pretty simple yet fast (pure libraries). These are the steps to make your Stackrecord account works with the CLI and API back-end.

  • Register at Stackrecord (or use API)
  • Generate a new API token at Stackrecord
  • Use --create {username} {api_token} to generate configuration file
  • Use --login {username} to login

Usage

The usage is divided in tree operations:

Requirements

Stack-CLI is currently deployed over pure Ruby libraries. The Ruby version is 1.9.3.

  • Ruby 1.9.3
  • yaml
  • fileutils
  • net/http
  • json

Installation

You can either use this CLI as compiled stand-alone available for Windows, Linux or Mac/OSX, or compile this by yourself. Installation is easy, either download MASTER zip file from GitHub repository or manually clone the repository.

cd ~
git clone https://github.com/stackrecord/stack-cli.git
chmod 777 -R stack-sli/

# Optionally, you may create a symbolic link in /usr/local/bin

Release notes

Support, bugs, requests, TODO

Please, if you have any critics, want to support the project, found a bug or just simply have a request, create an issue here on GitHub(https://github.com/stackrecord/stack-cli/issues)

License

This tool is registered and distrubuted by Stackrecord[http://stackrecord.com]. It's released under the GNU General Public v3 license.

stack-cli's People

Watchers

stackold avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.