README.md

   1 # OSDN Command Line Interface
   2
   3 OSDN command line interface using REST API.
   4
   5 ## Requirement
   6
   7 * ruby (>= 1.9.3)
   8 * gem build environment or pre-build ffi gem
   9 * libcurl
  10
  11 On debian (ubuntu) system, you can install with following packages.
  12
  13     $ sudo apt-get install ruby ruby-ffi libcurl3
  14
  15 ## Installation
  16
  17 You can install by rubygem, type following on terminal.
  18
  19     $ gem install osdn-cli
  20
  21 ## Usage
  22
  23 First you need to login to API with 'login' subcommand.
  24
  25     $ osdn login
  26
  27 To get command list use help.
  28
  29     $ osdn help
  30     osdn [global-options] <command> [command-options] [args]
  31     osdn help <command>
  32     Global Options:
  33       -h --help      Show help message. use 'help <command>' for specific command.
  34       -v --verbose   Increase log level (multiple)
  35       -q --quiet     Decrease log level (multiple)
  36     Avaiable Commands:
  37       help
  38       login          Login and save access token.
  39       package        Manipulate frs packages of project
  40       release        Manipulate frs releases of project
  41       relfile        Manipulate frs files of project
  42       frs_mkdirs     Make directory tree for current project release
  43       frs_upload     Upload local file tree and create package/release implicitly.
  44       ping           Test API request.
  45       vars           Get/set request environment variable.
  46
  47
  48 ## Contributing
  49
  50 Bug reports and pull requests are welcome on OSDN at https://osdn.jp/projects/osdn-codes/ticket/
  51
  52 ## License
  53
  54 Copyright (c) 2016 OSDN
  55
  56 Source files and gem are distributed under MIT License.