ruishi

终端增强工具，取瑞士军刀之意

Enligsh Doc

• 安装
• https://zhuanlan.zhihu.com/p/662190715
• 命令

安装

$ npm install -g ruishi

前置准备

需要提前安装: adb 和 scrcpy

macOS 系统，通过 brew 安装 adb 和 scrcpy：

$ brew install scrcpy
# https://zhuanlan.zhihu.com/p/662190715
$ brew install android-platform-tools

命令

• ruishi adb TOP
• ruishi adb clipboard ACTION [TEXT]
• ruishi adb cp ACTION [TEXT]
• ruishi adb proxy [ACTION] [PORT]
• ruishi adb tv
• ruishi hello PERSON
• ruishi hello world
• ruishi help [COMMAND]
• ruishi plugins
• ruishi plugins add PLUGIN
• ruishi plugins:inspect PLUGIN...
• ruishi plugins install PLUGIN
• ruishi plugins link PATH
• ruishi plugins remove [PLUGIN]
• ruishi plugins reset
• ruishi plugins uninstall [PLUGIN]
• ruishi plugins unlink [PLUGIN]
• ruishi plugins update

ruishi adb TOP

Say hello

USAGE
  $ ruishi adb TOP

ARGUMENTS
  TOP  show top activity

DESCRIPTION
  Say hello

EXAMPLES
  $ ruishi adb friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/adb/index.ts

ruishi adb clipboard ACTION [TEXT]

读取或写入安卓设备剪贴板内容（需 adb，推荐配合 clipper app）

USAGE
  $ ruishi adb clipboard ACTION [TEXT] [-t <value>]

ARGUMENTS
  ACTION  get 或 set
  TEXT    要写入剪贴板的内容

FLAGS
  -t, --text=<value>  要写入剪贴板的内容，仅 set 时有效

DESCRIPTION
  读取或写入安卓设备剪贴板内容（需 adb，推荐配合 clipper app）

EXAMPLES
  $ ruishi adb clipboard get
  读取安卓剪贴板内容（需先安装 clipper）

  $ ruishi adb clipboard set "hello world"
  写入剪贴板内容

  $ ruishi adb clipboard set --text "你好，世界"
  写入剪贴板内容

See code: src/commands/adb/clipboard.ts

ruishi adb cp ACTION [TEXT]

读取或写入安卓设备剪贴板内容（需 adb，推荐配合 clipper app）

USAGE
  $ ruishi adb cp ACTION [TEXT] [-t <value>]

ARGUMENTS
  ACTION  get 或 set
  TEXT    要写入剪贴板的内容

FLAGS
  -t, --text=<value>  要写入剪贴板的内容，仅 set 时有效

DESCRIPTION
  读取或写入安卓设备剪贴板内容（需 adb，推荐配合 clipper app）

EXAMPLES
  $ ruishi adb cp get
  读取安卓剪贴板内容（需先安装 clipper）

  $ ruishi adb cp set "hello world"
  写入剪贴板内容

  $ ruishi adb cp set --text "你好，世界"
  写入剪贴板内容

See code: src/commands/adb/cp.ts

ruishi adb proxy [ACTION] [PORT]

设置或取消 Android 设备的 http 代理

USAGE
  $ ruishi adb proxy [ACTION] [PORT] [--off | --on] [--port <value>]

ARGUMENTS
  ACTION  [default: on] on 或 off
  PORT    [default: 9090] 端口号

FLAGS
  --off           关闭代理
  --on            开启代理
  --port=<value>  [default: 9090] 代理端口

DESCRIPTION
  设置或取消 Android 设备的 http 代理

EXAMPLES
  $ ruishi adb proxy on 9090
  设置代理为本机IP:8888

  $ ruishi adb proxy off
  关闭代理

  $ ruishi adb proxy --on --port 9090
  设置代理为本机IP:8888

  $ ruishi adb proxy --off
  关闭代理

See code: src/commands/adb/proxy.ts

ruishi adb tv

使用scrcpy录制手机屏幕

USAGE
  $ ruishi adb tv [--audio] [--display]

FLAGS
  --[no-]audio    是否在录制时包含音频
  --[no-]display  是否在录制时显示屏幕内容

DESCRIPTION
  使用scrcpy录制手机屏幕

EXAMPLES
  $ ruishi adb tv
  开始录制手机屏幕，视频将保存在当前目录

  $ ruishi adb tv --no-display
  开始录制手机屏幕但不显示屏幕内容，视频将保存在当前目录

  $ ruishi adb tv --no-audio
  开始录制手机屏幕但不录制音频，视频将保存在当前目录

See code: src/commands/adb/tv.ts

ruishi hello PERSON

Say hello

USAGE
  $ ruishi hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ ruishi hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/hello/index.ts

ruishi hello world

Say hello world

USAGE
  $ ruishi hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ ruishi hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

ruishi help [COMMAND]

Display help for ruishi.

USAGE
  $ ruishi help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ruishi.

See code: @oclif/plugin-help

ruishi plugins

List installed plugins.

USAGE
  $ ruishi plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ruishi plugins

See code: @oclif/plugin-plugins

ruishi plugins add PLUGIN

Installs a plugin into ruishi.

USAGE
  $ ruishi plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into ruishi.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the RUISHI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the RUISHI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ ruishi plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ ruishi plugins add myplugin

  Install a plugin from a github url.

    $ ruishi plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ ruishi plugins add someuser/someplugin

ruishi plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ ruishi plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ ruishi plugins inspect myplugin

See code: @oclif/plugin-plugins

ruishi plugins install PLUGIN

Installs a plugin into ruishi.

USAGE
  $ ruishi plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into ruishi.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the RUISHI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the RUISHI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ ruishi plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ ruishi plugins install myplugin

  Install a plugin from a github url.

    $ ruishi plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ ruishi plugins install someuser/someplugin

See code: @oclif/plugin-plugins

ruishi plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ ruishi plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ ruishi plugins link myplugin

See code: @oclif/plugin-plugins

ruishi plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ruishi plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruishi plugins unlink
  $ ruishi plugins remove

EXAMPLES
  $ ruishi plugins remove myplugin

ruishi plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ ruishi plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

ruishi plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ruishi plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruishi plugins unlink
  $ ruishi plugins remove

EXAMPLES
  $ ruishi plugins uninstall myplugin

See code: @oclif/plugin-plugins

ruishi plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ ruishi plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ruishi plugins unlink
  $ ruishi plugins remove

EXAMPLES
  $ ruishi plugins unlink myplugin

ruishi plugins update

Update installed plugins.

USAGE
  $ ruishi plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

• ruishi adb tv
• ruishi-proxy on

ruishi adb tv

使用scrcpy录制手机屏幕

USAGE
  $ ruishi adb tv [--audio] [--display]

FLAGS
  --[no-]audio    是否在录制时包含音频
  --[no-]display  是否在录制时显示屏幕内容

DESCRIPTION
  使用scrcpy录制手机屏幕

EXAMPLES
  $ ruishi adb tv
  开始录制手机屏幕，视频将保存在当前目录

  $ ruishi adb tv --no-display
  开始录制手机屏幕但不显示屏幕内容，视频将保存在当前目录

  $ ruishi adb tv --no-audio
  开始录制手机屏幕但不录制音频，视频将保存在当前目录

See code: src/commands/adb/tv.ts

ruishi-proxy

通过 adb 给手机添加代理，需要提前

1. 安装: adb
2. 通过proxyman/charles/fiddler等工具，安装证书

使用教程
  $ ruishi-proxy on [port] # 开启代理，默认 9090
  $ ruishi-proxy off # 关闭代理