fir-cli 1.4.8 → 1.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27473f4f09804d0df210c601facda8cc44b863d7
-  data.tar.gz: ba0632fd67774815f55b92b82396d4cb818c4aa5
+  metadata.gz: 90ae72f438cf6fd7875108bf55144186b7e1184c
+  data.tar.gz: d3f2953c56f666afa334469784324953c90b3c96
 SHA512:
-  metadata.gz: 4e84960a168d32128f468e984e2814ede6a75187edff1698bc66907fe7aba142a9cb0b746c1b12b41c3bc1067834e4f7c0dcf8f6c9e8bd68986c224fd5290e09
-  data.tar.gz: 75f5ed37ff32aaf5c94926db800c20cb0ff9efecf733acd70076a6faae2bdd3c8fab6e8e993fd43e0c7cf8d026925ce19ec639d2b99228b0a0932548518fcbe8
+  metadata.gz: 39166292c62f7f4cb9b619953097757fd8283750c506530369dacc59e535eafe8401b192393424e603927c231f30404ad579646c13ff6c10101c017b7ee2f3de
+  data.tar.gz: 8694694118ab6973cc8049d9a8fdac632743ec64a9822828baa086b010ee48d22333c90f6888a50dce94c2ec47576f11753db4660c62b3e716909da22c753d45

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/CHANGELOG

@@ -1,5 +1,8 @@
 ## 更新记录
 
+### fir-cli 1.4.9
+- 修正 --password 与 --open 冲突的问题
+
 ### fir-cli 1.4.8
 - 修正 build 后直接 -p 发布的权限错误
 

data/README.md

@@ -6,236 +6,23 @@
 [![Test Coverage](https://codeclimate.com/github/FIRHQ/fir-cli/badges/coverage.svg)](https://codeclimate.com/github/FIRHQ/fir-cli/coverage)
 [![Gem Version](https://badge.fury.io/rb/fir-cli.svg)](http://badge.fury.io/rb/fir-cli)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/FIRHQ/fir-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/FIRHQ/fir-cli/master/LICENSE.txt)
 
 fir.im-cli 可以通过指令查看, 上传, 编译 iOS/Android 应用.
 
 ![fir-cli](http://7rf35s.com1.z0.glb.clouddn.com/fir-cli-new.gif)
 
-## 安装
+## 文档
 
-### OS X 安装
-
-在安装前需要确保 **OS X command line tools** 已经被提前安装好:
-
-```sh
-$ xcode-select --install
-```
-
-fir.im-cli 使用 Ruby 构建, 无需编译, 只要安装相应 ruby gem 即可(如果出现相关权限不足的错误, 请在命令行前加上 `sudo`):
-
-```sh
-$ gem install fir-cli
-```
-
-**注意: 如果你的系统是 Mac OS X 10.11 以后的版本, 由于10.11引入了 `rootless`, 无法直接安装 fir-cli, 有以下三种解决办法:**
-
-1\. 使用 [Homebrew](http://brew.sh/) 及 [RVM](https://rvm.io/) 安装 Ruby, 再安装 fir-cli(推荐)
-
-```sh
-# Install Homebrew:
-$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
-# Install RVM:
-$ \curl -sSL https://get.rvm.io | bash -s stable --ruby
-
-$ gem install fir-cli
-```
-
-2\. 指定 fir-cli 中 bin 文件的 PATH
-
-```sh
-$ export PATH=/usr/local/bin:$PATH;gem install -n /usr/local/bin fir-cli
-```
-
-3\. 重写 Ruby Gem 的 bindir
-
-```sh
-$ echo 'gem: --bindir /usr/local/bin' >> ~/.gemrc
-$ gem install fir-cli
-```
-
-### Linux 安装
-
-需要提前安装好 Ruby 版本 > 1.9.3
-
-```sh
-$ gem install fir-cli
-```
-
-**注意: 如果出现 `ERROR:  While executing gem ... (Gem::RemoteFetcher::FetchError)` 的错误, 请先更换 Ruby 的淘宝源(由于国内网络原因, 你懂的), 并升级下系统自带的 gem**
-
-```sh
-$ gem sources --remove https://rubygems.org/
-$ gem sources -a https://ruby.taobao.org/
-$ gem sources -l
-*** CURRENT SOURCES ***
-
-https://ruby.taobao.org
-# 请确保只有 ruby.taobao.org, 如果有其他的源, 请 remove 掉
-
-gem update --system
-gem install fir-cli
-```
-
-## 使用说明
-
-### fir help 使用说明
-
-`fir help` 命令不仅可以运行在 `fir` 主命令上, 还可以运行在相应子命令上查看相关的帮助
-
-```sh
-$ fir help
-Commands:
-  fir build_apk BUILD_DIR                       # Build Android app (alias: `ba`).
-  fir build_ipa BUILD_DIR [options] [settings]  # Build iOS app (alias: `bi`).
-  fir help                                      # Describe available commands or one specific command (aliases: `h`).
-  fir info APP_FILE_PATH                        # Show iOS/Android app info, support ipa/apk file (aliases: `i`).
-  fir login                                     # Login fir.im (aliases: `l`).
-  fir mapping MAPPING_FILE_PATH                 # Upload app mapping file to BugHD.com (aliases: `m`).
-  fir me                                        # Show current user info if user is logined.
-  fir publish APP_FILE_PATH                     # Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `...
-  fir upgrade                                   # Upgrade fir-cli and quit (aliases: `u`).
-  fir version                                   # Show fir-cli version number and quit (aliases: `v`).
-
-Options:
-  -T, [--token=TOKEN]              # User's API Token at fir.im
-  -L, [--logfile=LOGFILE]          # Path to writable logfile
-  -V, [--verbose], [--no-verbose]  # Show verbose
-                                   # Default: true
-  -q, [--quiet], [--no-quiet]      # Silence commands
-  -h, [--help], [--no-help]        # Show this help message and quit
-```
-#### 全局参数说明
-
-- `alias <short command>` 意味着可以用 alias 别名来代替该指令, 例如 `fir b`
-- `-T` 用户在 fir.im 上的 api_token
-- `-L` 指定 fir-cli 的输出 log, 默认为 STDOUT
-- `-V` Verbose, 默认为输出所有信息( INFO 和 ERROR), 如果设置 `--no-verbose`, 则只输出 ERROR 信息
-- `-q` 静默模式, 默认关闭
-- `-h` 查看相关命令帮助
-
-### fir publish 使用说明
-
-fir publish 命令可以轻松发布应用到 fir.im, 支持 ipa 和 apk 文件.
-
-```sh
-$ fir publish path/to/application -T YOUR_FIR_TOKEN
-```
-
-如果需要上传 changelog, 自定义 short 地址, 设置密码, 设置公开访问权限, 上传符号表, 生成二维码等功能, 可以使用 `fir publish -h`查看相应的帮助
-
-### fir login 使用说明
-
-如果觉得每次上传都输入 `-T` 很不方便, 那么可使用 `login` 命令
-
-```sh
-$ fir login
-```
-
-这时系统会提示输入用户 API token, 用户的 API token 可在 **[这里](http://fir.im/apps/apitoken)** 的右上角查看
-
-```sh
-Please enter your fir.im API Token:
-I, [2015-08-26T10:10:28.235295 #6833]  INFO -- : Login succeed, previous user's email: xxx@xxx.com
-I, [2015-08-26T10:10:28.245083 #6833]  INFO -- : Login succeed, current  user's email: xxx@xxx.com
-I, [2015-08-26T10:10:28.245152 #6833]  INFO -- :
-```
-
-### fir build 使用说明
-
-该指令分为两个不同的指令, `build_ipa` 和 `build_apk`, 可以编译 ipa 及 apk 应用并上传到 fir.im
-
-#### 编译 ipa
-
-`build_ipa` 对 `xcodebuild` 原生指令进行了封装, 将常用的参数名简化, 支持全部的自带参数及设置, 同时输出符号表 dSYM 文件.
-
-编译 project
-
-```
-$ fir build_ipa path/to/project -o path/to/output
-```
-
-编译 workspace
-
-```sh
-$ fir build_ipa path/to/workspace -o path/to/output -w -C Release -t allTargets GCC_PREPROCESSOR_DEFINITIONS="FOO=bar"
-```
-
-该指令在指向的目录中，找到第一个 workspace 文件，对其进行编译。使用 `Release` 设置，编译策略为 `allTargets`，同时设置了预编译参数 `FOO`。
-
-编译用 CocoaPods 做依赖管理的 .ipa 包
-
-```sh
-$ fir build_ipa path/to/workspace -w -S <scheme name>
-```
-
-#### 编译用 Gradle 打包 apk
-
-```sh
-# 简单打包
-$ fir build_apk path/to/project
-
-# 打包并上传
-$ fir ba <project dir> [-o <apk output dir> -c <changelog> -p -Q -T <your api token>]
-
-# 打包指定的 flavor
-$ fir ba <project dir> [-f <flavor> -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
-
-# 打包指定的 git branch
-$ fir ba <git ssh url> [-B develop -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
-```
-
-#### 编译并且上传至 fir.im
-
-只需要输入 `-p -T` 即可
-
-```sh
-$ fir build_ipa/build_apk path/to/project -o path/to/output -p -T YOUR_FIR_TOKEN -c YOUR_CHANGELOG
-```
-
-如果需要更详细的使用说明, 可以使用 `fir build_ipa/build_apk -h`查看相应的帮助
-
-### fir mapping 使用说明
-
-该指令可以上传符号表至 [BugHD.com](http://bughd.com) 所对应的项目, 目前已经支持 dSYM 和 txt 两种格式的符号表文件上传, 有以下三种方法上传:
-
-> 指定 version 和 build 上传:
-
-```sh
-$ fir m <mapping file path> -P <bughd project id> -v <app version> -b <app build> -T <your api token>
-```
-
-> 在 publish 的时候自动上传:
-
-```sh
-$ fir p <app file path> -m <mapping file path> -P <bughd project id> -T <your api token>
-```
-> 在 build_ipa 的时候自动上传:
-
-```sh
-$ fir b <project dir> -P <bughd project id> -M -p -T <your api token>
-```
-
-如果需要更详细的使用说明, 可以使用 `fir mapping -h`查看相应的帮助
-
-### fir me 使用说明
-
-该指令可以查看当前使用者
-
-```sh
-$ fir me
-I, [2015-11-02T03:03:04.933645 #29886]  INFO -- : Login succeed, current user's email: xxxx
-I, [2015-11-02T03:03:04.933756 #29886]  INFO -- : Login succeed, current user's name:  xxxx
-I, [2015-11-02T03:03:04.933787 #29886]  INFO -- :
-```
-
-### fir upgrade 使用说明
-
-该指令用于升级最新版本的 fir-cli
-
-```sh
-$ fir upgrade
-```
+- [安装及常见安装问题](https://github.com/FIRHQ/fir-cli/blob/master/doc/install.md)
+- [fir help 相关指令帮助](https://github.com/FIRHQ/fir-cli/blob/master/doc/help.md)
+- [fir info 查看 ipa/apk 信息](https://github.com/FIRHQ/fir-cli/blob/master/doc/info.md)
+- [fir login & fir me 登录相关](https://github.com/FIRHQ/fir-cli/blob/master/doc/login.md)
+- [fir publish 发布应用到 fir.im](https://github.com/FIRHQ/fir-cli/blob/master/doc/publish.md)
+- [fir build_ipa 编译打包 ipa 文件](https://github.com/FIRHQ/fir-cli/blob/master/doc/build_ipa.md)
+- [fir build_apk 编译打包 apk 文件](https://github.com/FIRHQ/fir-cli/blob/master/doc/build_apk.md)
+- [fir mapping 上传符号表至 BugHD.com](https://github.com/FIRHQ/fir-cli/blob/master/doc/mapping.md)
+- [fir upgrade 升级相关](https://github.com/FIRHQ/fir-cli/blob/master/doc/upgrade.md)
 
 ## 提交反馈
 
@@ -247,3 +34,4 @@ $ fir upgrade
 
 ![](http://7rf35s.com1.z0.glb.clouddn.com/coffee.png)
 
+

data/doc/build_apk.md

@@ -0,0 +1,42 @@
+#### fir build_apk
+
+`fir build_apk` 指令用于编译用 Gradle 打包 apk, 并且支持直接从 Github/Gitlab 相关 repo 直接编译打包.
+
+```sh
+fir build_apk --help
+Usage:
+  fir build_apk BUILD_DIR
+
+Options:
+  -B, [--branch=BRANCH]            # Set branch if project is a git repo, the default is `master`
+  -o, [--output=OUTPUT]            # APK output path, the default is: BUILD_DIR/build/outputs/apk
+  -p, [--publish], [--no-publish]  # true/false if publish to fir.im
+  -f, [--flavor=FLAVOR]            # Set flavor if have productFlavors
+  -s, [--short=SHORT]              # Set custom short link if publish to fir.im
+  -n, [--name=NAME]                # Set custom apk name when builded
+  -c, [--changelog=CHANGELOG]      # Set changelog if publish to fir.im, support string/file
+  -Q, [--qrcode], [--no-qrcode]    # Generate qrcode
+      [--open], [--no-open]        # true/false if open for everyone, the default is: true
+                                   # Default: true
+      [--password=PASSWORD]        # Set password for app
+  -T, [--token=TOKEN]              # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]          # Path to writable logfile
+  -V, [--verbose], [--no-verbose]  # Show verbose
+                                   # Default: true
+  -q, [--quiet], [--no-quiet]      # Silence commands
+  -h, [--help], [--no-help]        # Show this help message and quit
+```
+
+```sh
+# 简单打包
+$ fir build_apk path/to/project
+
+# 打包并上传
+$ fir ba <project dir> [-o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+
+# 打包指定的 flavor
+$ fir ba <project dir> [-f <flavor> -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+
+# 打包指定的 git branch
+$ fir ba <git ssh url> [-B develop -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+```

data/doc/build_ipa.md

@@ -0,0 +1,57 @@
+### fir build_ipa
+
+`fir build_ipa` 对 `xcodebuild` 原生指令进行了封装, 将常用的参数名简化, 支持全部的自带参数及设置, 同时输出符号表 dSYM 文件, 并且支持直接从 Github/Gitlab 相关 repo 直接编译打包.
+
+```sh
+$ fir build_ipa --help
+fir build_ipa --help
+Usage:
+  fir build_ipa BUILD_DIR [options] [settings]
+
+Options:
+  -B, [--branch=BRANCH]                # Set branch if project is a git repo, the default is `master`
+  -w, [--workspace], [--no-workspace]  # true/false if build workspace
+  -S, [--scheme=SCHEME]                # Set the scheme NAME if build workspace
+  -C, [--configuration=CONFIGURATION]  # Use the build configuration NAME for building each target
+  -d, [--destination=DESTINATION]      # Set the destinationspecifier
+  -t, [--target=TARGET]                # Build the target specified by targetname
+  -f, [--profile=PROFILE]              # Set the export provisioning profile
+  -o, [--output=OUTPUT]                # IPA output path, the default is: BUILD_DIR/fir_build_ipa
+  -p, [--publish], [--no-publish]      # true/false if publish to fir.im
+  -s, [--short=SHORT]                  # Set custom short link if publish to fir.im
+  -n, [--name=NAME]                    # Set custom ipa name when builded
+  -c, [--changelog=CHANGELOG]          # Set changelog if publish to fir.im
+  -Q, [--qrcode], [--no-qrcode]        # Generate qrcode
+  -M, [--mapping], [--no-mapping]      # true/false if upload app mapping file to BugHD.com
+  -P, [--proj=PROJ]                    # Project id in BugHD.com if upload app mapping file
+      [--open], [--no-open]            # true/false if open for everyone, the default is: true
+                                       # Default: true
+      [--password=PASSWORD]            # Set password for app
+  -T, [--token=TOKEN]                  # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]              # Path to writable logfile
+  -V, [--verbose], [--no-verbose]      # Show verbose
+                                       # Default: true
+  -q, [--quiet], [--no-quiet]          # Silence commands
+  -h, [--help], [--no-help]            # Show this help message and quit
+```
+
+示例:
+
+- 编译 project, 加上 changelog, 并发布到 fir.im 上并生成二维码图片
+
+  ```
+  $ fir build_ipa path/to/project -o path/to/output -p -c "this is changelog" -Q -T YOUR_API_TOKEN
+  ```
+
+- 编译 Github 上的 workspace
+
+  ```sh
+  $ fir build_ipa git@github.com:xxxx.git -o path/to/output -w -C Release -t allTargets GCC_PREPROCESSOR_DEFINITIONS="FOO=bar"
+  ```
+  该指令在指向的目录中，找到第一个 workspace 文件, 对其进行编译. 使用 `Release` 设置，编译策略为 `allTargets`, 同时设置了预编译参数 `FOO`.
+
+- 编译用 CocoaPods 做依赖管理的 .ipa 包
+
+  ```sh
+  $ fir build_ipa path/to/workspace -w -S <scheme name>
+  ```

data/doc/help.md

@@ -0,0 +1,34 @@
+### 相关指令帮助
+
+`fir help` 命令不仅可以运行在 `fir` 主命令上, 还可以运行在相应子命令上查看相关的帮助.
+
+```sh
+$ fir help
+Commands:
+  fir build_apk BUILD_DIR                       # Build Android app (alias: `ba`).
+  fir build_ipa BUILD_DIR [options] [settings]  # Build iOS app (alias: `bi`).
+  fir help                                      # Describe available commands or one specific command (aliases: `h`).
+  fir info APP_FILE_PATH                        # Show iOS/Android app info, support ipa/apk file (aliases: `i`).
+  fir login                                     # Login fir.im (aliases: `l`).
+  fir mapping MAPPING_FILE_PATH                 # Upload app mapping file to BugHD.com (aliases: `m`).
+  fir me                                        # Show current user info if user is logined.
+  fir publish APP_FILE_PATH                     # Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `...
+  fir upgrade                                   # Upgrade fir-cli and quit (aliases: `u`).
+  fir version                                   # Show fir-cli version number and quit (aliases: `v`).
+
+Options:
+  -T, [--token=TOKEN]              # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]          # Path to writable logfile
+  -V, [--verbose], [--no-verbose]  # Show verbose
+                                   # Default: true
+  -q, [--quiet], [--no-quiet]      # Silence commands
+  -h, [--help], [--no-help]        # Show this help message and quit
+```
+#### 全局参数说明
+
+- `alias <short command>` 意味着可以用 alias 别名来代替该指令, 例如 `fir b`
+- `-T` 用户在 fir.im 上的 api_token
+- `-L` 指定 fir-cli 的输出 log, 默认为 STDOUT
+- `-V` Verbose, 默认为输出所有信息( INFO 和 ERROR), 如果设置 `--no-verbose`, 则只输出 ERROR 信息
+- `-q` 静默模式, 默认关闭
+- `-h` 查看相关命令帮助

data/doc/info.md

@@ -0,0 +1,44 @@
+### fir info
+
+`fir info` 命令用于查看当前 ipa/apk 相关信息.
+
+```sh
+$ fir info --help
+Usage:
+  fir info APP_FILE_PATH
+
+Show iOS/Android app info, support ipa/apk file (aliases: `i`).
+```
+
+#### 查看 ipa 相关信息
+
+```sh
+$ fir info ./build_ipa.ipa
+
+I, [2016-03-08T12:28:29.310846 #11961]  INFO -- : Analyzing ipa file......
+I, [2016-03-08T12:28:29.310932 #11961]  INFO -- : ✈ -------------------------------------------- ✈
+I, [2016-03-08T12:28:29.395706 #11961]  INFO -- : type: ios
+I, [2016-03-08T12:28:29.395775 #11961]  INFO -- : identifier: xx.xxx.build-ipa
+I, [2016-03-08T12:28:29.395793 #11961]  INFO -- : name: build_ipa
+I, [2016-03-08T12:28:29.395805 #11961]  INFO -- : display_name: build_ipa
+I, [2016-03-08T12:28:29.395817 #11961]  INFO -- : build: 1
+I, [2016-03-08T12:28:29.395829 #11961]  INFO -- : version: 1.0
+I, [2016-03-08T12:28:29.396007 #11961]  INFO -- : devices: ["fasdfafaf3f4xxxxxxx78aecbc1234567"]
+I, [2016-03-08T12:28:29.396057 #11961]  INFO -- : release_type: adhoc
+I, [2016-03-08T12:28:29.396086 #11961]  INFO -- : distribution_name: iOSTeam Provisioning Profile: xx.xxx.* - xxx xx xxxxxx LLC.
+I, [2016-03-08T12:28:29.396111 #11961]  INFO -- :
+```
+
+#### 查看 apk 相关信息
+
+```sh
+$ fir info ./test_apk.apk
+I, [2016-03-08T12:30:25.241278 #12073]  INFO -- : Analyzing apk file......
+I, [2016-03-08T12:30:25.241363 #12073]  INFO -- : ✈ -------------------------------------------- ✈
+I, [2016-03-08T12:30:25.250430 #12073]  INFO -- : type: android
+I, [2016-03-08T12:30:25.250477 #12073]  INFO -- : identifier: com.xxx.myapplication
+I, [2016-03-08T12:30:25.250496 #12073]  INFO -- : name: My Application
+I, [2016-03-08T12:30:25.250509 #12073]  INFO -- : build: 1
+I, [2016-03-08T12:30:25.250520 #12073]  INFO -- : version: 1.0
+I, [2016-03-08T12:30:25.250532 #12073]  INFO -- :
+```

data/doc/install.md

@@ -0,0 +1,65 @@
+### 安装
+
+fir-cli 使用 Ruby 构建, 无需编译, 只要安装相应 gem 即可.
+
+```sh
+$ ruby -v # > 1.9.3
+$ gem install fir-cli
+```
+
+#### 常见的安装问题
+
+- 使用系统自带的 Ruby 安装, 需确保 ruby-dev 已被正确的安装:
+
+  ```sh
+  $ xcode-select --install        # OS X 系统
+  $ sudo apt-get install ruby-dev # Linux 系统
+  ```
+
+- 出现 `Permission denied` 相关错误:
+
+  在命令前加上 `sudo`
+
+- 出现 `Gem::RemoteFetcher::FetchError` 相关错误:
+
+  更换 Ruby 的淘宝源(由于国内网络原因, 你懂的), 并升级下系统自带的 gem
+
+  ```sh
+  $ gem sources --remove https://rubygems.org/
+  $ gem sources -a https://ruby.taobao.org/
+  $ gem sources -l
+  *** CURRENT SOURCES ***
+
+  https://ruby.taobao.org
+  # 请确保只有 ruby.taobao.org, 如果有其他的源, 请 remove 掉
+
+  gem update --system
+  gem install fir-cli
+  ```
+
+- Mac OS X 10.11 以后的版本, 由于10.11引入了 `rootless`, 无法直接安装 fir-cli, 有以下三种解决办法:**
+
+  1\. 使用 [Homebrew](http://brew.sh/) 及 [RVM](https://rvm.io/) 安装 Ruby, 再安装 fir-cli(推荐)
+
+  ```sh
+  # Install Homebrew:
+  $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+  # Install RVM:
+  $ \curl -sSL https://get.rvm.io | bash -s stable --ruby
+
+  $ gem install fir-cli
+  ```
+
+  2\. 指定 fir-cli 中 bin 文件的 PATH
+
+  ```sh
+  $ export PATH=/usr/local/bin:$PATH;gem install -n /usr/local/bin fir-cli
+  ```
+
+  3\. 重写 Ruby Gem 的 bindir
+
+  ```sh
+  $ echo 'gem: --bindir /usr/local/bin' >> ~/.gemrc
+  $ gem install fir-cli
+  ```

data/doc/login.md

@@ -0,0 +1,19 @@
+### fir login & fir me
+
+`fir login` 命令用于使用 API token 登录 fir.im, 并使用发布应用等相关命令.
+
+`fir me` 命令用于查看当前登录用户信息.
+
+用户的 API token 可在 **[这里](http://fir.im/apps/apitoken)** 查看, 当使用 fir login 登录了之后, 后续命令都不需要加上 `-T` 参数, 会默认使用 **当前用户的 token** 进行相关操作.
+
+```sh
+$ fir login XXX_YOUR_API_TOKEN_XXX
+I, [2016-03-08T12:48:56.499435 #13043]  INFO -- : Login succeed, previous user's email: xxx@fir.im
+I, [2016-03-08T12:48:56.507044 #13043]  INFO -- : Login succeed, current  user's email: xxx@fir.im
+I, [2016-03-08T12:48:56.507147 #13043]  INFO -- :
+
+$ fir me
+I, [2016-03-08T12:48:14.175488 #12986]  INFO -- : Login succeed, current user's email: xxx@fir.im
+I, [2016-03-08T12:48:14.175687 #12986]  INFO -- : Login succeed, current user's name:  xxx
+I, [2016-03-08T12:48:14.175765 #12986]  INFO -- :
+```

data/doc/mapping.md

@@ -0,0 +1,22 @@
+### fir mapping
+
+`fir mapping` 指令用于将符号表上传至 [BugHD.com](http://bughd.com) 所对应的项目, 目前已经支持 dSYM 和 txt 两种格式的符号表文件上传, 有以下三种方法上传:
+
+- 指定 version 和 build 上传:
+
+  ```sh
+  $ fir m <mapping file path> -P <bughd project id> -v <app version> -b <app build> -T <your api token>
+  ```
+
+- 在 publish 的时候自动上传:
+
+  ```sh
+  $ fir p <app file path> -m <mapping file path> -P <bughd project id> -T <your api token>
+  ```
+- 在 build_ipa 的时候自动上传:
+
+  ```sh
+  $ fir b <project dir> -P <bughd project id> -M -p -T <your api token>
+  ```
+
+更详细的使用说明, 可以使用 `fir mapping -h`查看相应的帮助.

data/doc/publish.md

@@ -0,0 +1,36 @@
+### fir publish
+
+`fir publish` 命令用于可以发布应用到 fir.im, 支持 ipa 和 apk 文件.
+
+```sh
+$ fir publish --help
+Usage:
+  fir publish APP_FILE_PATH
+
+Options:
+  -s, [--short=SHORT]              # Set custom short link
+  -c, [--changelog=CHANGELOG]      # Set changelog
+  -Q, [--qrcode], [--no-qrcode]    # Generate qrcode
+  -m, [--mappingfile=MAPPINGFILE]  # App mapping file
+  -P, [--proj=PROJ]                # Project id in BugHD.com if upload app mapping file
+      [--open], [--no-open]        # true/false if open for everyone, the default is: true
+                                   # Default: true
+      [--password=PASSWORD]        # Set password for app
+  -T, [--token=TOKEN]              # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]          # Path to writable logfile
+  -V, [--verbose], [--no-verbose]  # Show verbose
+                                   # Default: true
+  -q, [--quiet], [--no-quiet]      # Silence commands
+  -h, [--help], [--no-help]        # Show this help message and quit
+```
+
+相关参数详解:
+
+- `-s` 参数, 自定义发布后的短链接地址.
+- `-c` 参数, 自定义发布时的 changelog, 支持字符串与文件两种方式, 即 `--changelog='this is changelog'` 和 `--changelog='/Users/fir-cli/changelog'`.
+- `-Q` 参数, 是否生成发布后二维码, 默认为不生成, 加上 `-Q` 参数后会在当前目录生成一张二维码图片, 扫描该图片即可下载该应用.
+- `-m` 参数, 上传当前应用的符号表文件, 配合 `-P` 参数使用.
+- `-P` 参数, [BugHD.com](http://bughd.com) 上相对应的 Project id.
+- `--open` 参数, 设置发布后的应用是否开放给所有人下载, 默认为开放, 关闭开放使用 `--no-open` 参数.
+- `--password` 参数, 设置发布后的应用密码
+

data/doc/upgrade.md

@@ -0,0 +1,7 @@
+#### fir upgrade
+
+`fir upgrade` 指令用于升级最新版本的 fir-cli
+
+```sh
+$ fir upgrade
+```

data/fir-cli.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
     /_/   /___/_/ |_|      \____/_____/___/
 
   ## 更新记录
-  ### fir-cli 1.4.8
+  ### fir-cli 1.4.9
   - 修正 build 后直接 -p 发布的权限错误
   - 增加上传时候设置密码及公开访问权限
   - 增加 build_ipa 中的 destination 参数

data/lib/fir/util/publish.rb

@@ -159,7 +159,7 @@ module FIR
       @changelog     = read_changelog(options[:changelog]).to_s.to_utf8
       @short         = options[:short].to_s
       @passwd        = options[:password].to_s
-      @is_opened     = !!options[:open]
+      @is_opened     = @passwd.blank? ? !!options[:open] : false
       @export_qrcode = !!options[:qrcode]
     end
 

data/lib/fir/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module FIR
-  VERSION = '1.4.8'
+  VERSION = '1.4.9'
 end

data/test/publish_test.rb

@@ -16,9 +16,22 @@ class PublishTest < Minitest::Test
 
   def test_update_app_info
     short     = SecureRandom.hex[3..9]
-    passwd    = SecureRandom.hex[0..9]
     is_opened = (rand(100) % 2) == 0
 
+    update_info = { short: short, open: is_opened }
+    FIR.publish(default_ipa, @options.merge(update_info))
+
+    info = FIR.fetch_app_info
+
+    assert_equal short, info[:short]
+    assert_equal is_opened, info[:is_opened]
+  end
+
+  def test_update_app_passwd
+    short     = SecureRandom.hex[3..9]
+    is_opened = (rand(100) % 2) == 0
+    passwd    = SecureRandom.hex[0..9]
+
     update_info = { short: short, password: passwd, open: is_opened }
     FIR.publish(default_ipa, @options.merge(update_info))
 
@@ -26,6 +39,6 @@ class PublishTest < Minitest::Test
 
     assert_equal short, info[:short]
     assert_equal passwd, info[:passwd]
-    assert_equal is_opened, info[:is_opened]
+    assert_equal false, info[:is_opened]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fir-cli
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.4.9
 platform: ruby
 authors:
 - NaixSpirit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,15 @@ files:
 - bin/console
 - bin/fir
 - bin/setup
+- doc/build_apk.md
+- doc/build_ipa.md
+- doc/help.md
+- doc/info.md
+- doc/install.md
+- doc/login.md
+- doc/mapping.md
+- doc/publish.md
+- doc/upgrade.md
 - fir-cli.gemspec
 - lib/fir-cli.rb
 - lib/fir.rb
@@ -206,7 +215,7 @@ metadata: {}
 post_install_message: "\n        ______________        ________    ____\n       /
   ____/  _/ __ \\      / ____/ /   /  _/\n      / /_   / // /_/ /_____/ /   / /    /
   /\n     / __/ _/ // _, _/_____/ /___/ /____/ /\n    /_/   /___/_/ |_|      \\____/_____/___/\n\n
-  \ ## 更新记录\n  ### fir-cli 1.4.8\n  - 修正 build 后直接 -p 发布的权限错误\n  - 增加上传时候设置密码及公开访问权限\n
+  \ ## 更新记录\n  ### fir-cli 1.4.9\n  - 修正 build 后直接 -p 发布的权限错误\n  - 增加上传时候设置密码及公开访问权限\n
   \ - 增加 build_ipa 中的 destination 参数\n  - 详细更新记录, 请查看: https://github.com/FIRHQ/fir-cli/blob/master/CHANGELOG\n
   \ - [fir-cli](https://github.com/FIRHQ/fir-cli) 已经开源\n  - 欢迎 fork, issue 和 pull
   request\n  "