$ ionic docs
打开IonicWeb文档
命令
$ ionic docs
明细
| 选项 | 描述 |
|---|
--browser, -w | 指定要使用的浏览器 (safari, firefox, google chrome) |
$ ionic generate
生成pipes, components, pages, directives, providers, and tabs (ionic-angular >= 3.0.0)
命令
$ ionic generate [<type>] [<name>]
明细
自动为你的Ionic项目创建组建
名字应按照适当的名称规范去定义,例如: ionic generate page neat 在src/pages/neat/创建一个名字为NeatPage的页面
| 参数 | 描述 |
|---|
type | 创建组件的类型 (e.g. component, directive, page, pipe, provider, tabs) |
name | 创建组件的名字 |
| 选项 | 描述 |
|---|
--no-module | 不为组建生成NgModule |
--constants | 为延迟加载的页面生成一个页面常量文件 |
案例
$ ionic generate
$ ionic generate component
$ ionic generate directive
$ ionic generate page
$ ionic generate pipe
$ ionic generate provider
$ ionic generate tabs
$ ionic generate component foo
$ ionic generate page Login
$ ionic generate page Detail --no-module
$ ionic generate page About --constants
$ ionic generate pipe MyFilterPipe
$ ionic info
打印系统/环境变量信息
命令
$ ionic info
$ ionic link
将你本地的APP连接到Ionic
命令
$ ionic link[<app_id>]
明细
如果你在Ionic上面有一个应用,你可以用这条命令将他连接到本地的IonicApp上
不包括app_id 参数,你可以在Ionic上查找你的应用,并提示你选择一个。
这条命令简单的在ionic.config.json中设置了app_id 属性来让其他命令能够读取到。
| Input | Description |
|---|
app_id | app连接的id (e.g. a1b2c3d4) |
| Option | Description |
|---|
--name | 在新应用的链接中使用的应用名称 |
案例
$ ionic link
$ ionic link a1b2c3d4
$ ionic login
用你的Ionic账号进行登陆
命令
$ ionic login [<email>][<password>]
明细
通过储存在CLI配置文件中的配置信息,在Ionic服务器上进行身份验证,并检索用户的token。
另外,设置Ionic电子邮件和离子密码环境变量,并且CLI将自动对您进行身份验证。
如果你要创建一个账号,需要使用ionic signup
| 参数 | 描述 |
|---|
email | 你的电子邮件地址 |
password | 你的密码 |
案例
$ ionic login
$ ionic login john@example.com
$ ionic login hello@example.com secret
$ ionic serve
启动一个本地开发服务器,用于应用程序开发/测试
命令
$ ionic serve
明细
很容易在浏览器中启动开发服务器。它会监视源文件中的更改,并自动重新加载修改后的构建。
默认情况下,Ionic服务在所有网络接口上启动一个开发服务器,并打印出你的应用程序正在使用的外部地址(es)。
它还会将你的应用程序发布到你的网络上的IonicDevApp。要禁用DevApp并绑定到本地主机,请使用--local命令
尝试一下--lab选项,可以同时看到多个平台。
| 选项 | 描述 |
|---|
--consolelogs, -c | 打印应用控制台日志到Ionic CLI |
--address | 为开发服务器使用自定义的地址 |
--port, -p | 使用自定义的HTTP端口 |
--livereload-port, -r | 使用特定端口进行重新加载 |
--dev-logger-port | 为dev服务器通信使用特定端口 |
--no-devapp | 不发布DevApp服务 |
--no-open | 不打开浏览器窗口 |
--local | 禁用外部网络的使用 |
--no-proxy | 不添加代理 |
--browser, -w | 指定要使用的浏览器 (safari, firefox, google chrome) |
--browseroption, -o | 指定要打开的路径 (/#/tab/dash) |
--lab, -l | 在浏览器中测试你的应用程序 |
--platform, -t | 开始服务于一个特定的平台( (android, ios) |
案例
$ ionic serve -c
$ ionic serve --lab -c
$ ionic signup
创建一个Ionic帐户
命令
$ ionic signup
$ ionic start
创建一个新的项目
命令
$ ionic start [<name>][<template>]
明细
这个命令创建一个工作的Ionic应用程序。它为您安装依赖项,并设置您的项目。
ionic start 将会按照template模板创建一个新的app,你可以用--list选项列出所有模板列表。更多信息请查阅CLI文档。[1]
你也可以为template指定一个git repository URL,然后你已经存在的项目将会被clone到本地。
[1]: https://ionicframework.com/docs/cli/starters.html
| 参数 | 描述 |
|---|
name | 项目的名称 |
template | 使用的启动模板 (e.g. blank, tabs; use --list to see all) |
| 选项 | 描述 |
|---|
--list, -l | 列出可用的启动模板列表 |
--type | 启动项目的类型 (e.g. ionic-angular, ionic1) |
--display-name, -n | 人可读的名字(在名字附近使用引号) |
--cordova | 加入 Cordova 集成 |
--no-deps | 不安装 npm/yarn 的依赖 |
--no-git | 不配置GIt资源库 |
--no-link | 不连接到Ionic上已有的项目 |
--pro-id | 从Ionic指示板中指定一个应用ID为链接 |
--bundle-id | 为您的应用程序指定bundle ID/application ID(反向dns标记) |
案例
$ ionic start
$ ionic start --list
$ ionic start myApp blank
$ ionic start myApp tabs --cordova
$ ionic start myApp blank --type=ionic1
$ ionic start myConferenceApp https://github.com/ionic-team/ionic-conference-app
$ ionic telemetry
选择输入和输出监测
命令
$ ionic telemetry [<status>]
明细
$ ionic upload
上传你的应用程序的新快照
命令
$ ionic upload
明细
警告:Ionic云已被弃用,将于2018年1月31日结束使用。此后将不支持此命令。IonicPro采用了不同的上传方式。
有关详细信息,请参阅入门文档: https://ionicframework.com/docs/pro/basics/getting-started/
Zips up your local app files and uploads a snapshot to Ionic.
From there, you can use Ionic View (https://ionicframework.com/pro/view) to easily share your app with your organization and testers around the world.
把你的本地应用程序文件上传,并将快照上传至Inoic。
从那里,您可以使用Ionic视图( https://ionicframework.com/pro/view )轻松地分享你的应用程序与世界各地的组织和测试人员。
| 选项 | 描述 |
|---|
--note | 给这个快照一个很好的描述 |
--deploy | 将此快照部署到指定的频道 |
--metadata | 为部署设置定制的元数据JSON |
--no-build | 不调用 Ionic build |
--prod | 构建用于生产的应用程序 |
--aot | 为这个构建执行 ahead-of-time |
--minifyjs | 为这个构建提供Minify JS |
--minifycss | 为这个构建提供Minify CSS |
--optimizejs | 为这个构建执行JS优化 |
案例
$ ionic upload
$ ionic upload --deploy=dev$ ionic upload --deploy=production --note="add menu entry" --metadata="{\"custom_data\":true}"
$ ionic config get
打印配置的值
命令
$ ionic config get [<property>]
明细
默认情况下,该命令在项目的ionic.config.json文件中打印属性。
对于--global config,CLI在全局CLI配置文件(~/.ionic/config.json)中打印属性。
对于嵌套属性,用点分隔的嵌套级别。
例如,属性名称user.email将在电子email 字段中查看用户对象(全局CLI配置文件中的根级字段)。
如果没有属性参数,此命令将打印出整个文件内容。
如果您以命令行方式使用此命令,您可以使用--json option
这个命令试图为已知的敏感字段进行配置输出,比如全局CLI配置文件中的令牌对象中的字段。
此功能在使用时禁用--json
| 选项 | 描述 |
|---|
--global, -g | 使用全局CLI配置 |
--json | 在JSON中输出配置值 |
Examples
$ ionic config get
$ ionic config get app_id
$ ionic config get --global user.email
$ ionic config get -g yarn
$ ionic config set
设置配置值
命令
$ ionic config set[<property>][<value>]
明细
默认情况下,这个命令在项目的ionic.config.json文件中设置JSON属性。
对于--global,CLI在全局CLI配置文件(~/.ionic/config.json)中设置属性。
对于嵌套属性,用点分隔的嵌套级别。
例如,属性名user.email将在email字段中查看user 对象(全局CLI配置文件中的根级字段)。
ionic config set will attempt to coerce value into a suitable JSON type. If it is JSON-parsable, such as true or [], it takes the parsed result. Otherwise, the value is interpreted as a string. For stricter input, use --json, which will error with non-JSON values.
ionic config set将尝试将值强制转换为合适的JSON类型。如果是JSON-parsable,如true或[],则需要经过解析的结果。否则,该值将被解释为一个字符串。对于更严格的输入,使用非json值的--json。
默认情况下,如果属性存在并且是一个对象或一个数组,那么该值不会被覆盖。
要禁用这个检查,并且总是覆盖属性,使用--force
| 参数 | 描述 |
|---|
property | 您希望设置的属性名 |
value | 给定属性的新值 |
| 选项 | 描述 |
|---|
--global, -g | 使用全局CLI配置 |
--json | 总是将值解释为JSON |
--force | 总是覆盖现有值 |
案例
$ ionic config setname newAppName
$ ionic config setname "\"newAppName\"" --json
$ ionic config setwatchPatterns "[]" --force
$ ionic config set -g yarn true
$ ionic cordova build
构建(prepare + compile)一个给定平台的Ionic项目
命令
$ ionic cordova build [<platform>]
明细
就像直接运行cordova build一样,但也可以构建web资产并提供友好的检查。
要将额外的选项传递给Cordova CLI,请在离子CLI参数之后使用--分隔符。
例如,在iOS版本中,Cordova的详细日志输出,会使用ionic cordova build ios -- -d查看下面的其他例子。
请参阅下面的额外的例子。
| 参数 | 描述 |
|---|
platform | 平台构建 (android, ios) |
| Option | Description |
|---|
--no-build | 不调用 Ionic build |
--prod | 构建用于生产的应用程序 |
--aot | 为这个构建执行ahead-of-time编译 |
--minifyjs | 为这个构建提供Minify JS |
--minifycss | 为这个构建提供Minify CSS |
--optimizejs | 为这个构建执行JS优化 |
--debug | 创建一个Cordova的调试构建 |
--release | 创建一个Cordova的版本 |
--device | 为一个设备创建一个Cordova的构建 |
--emulator | 为模拟器创建一个Cordova的构建 |
--buildConfig | 使用指定的Cordova构建配置 |
案例
$ ionic cordova build ios
$ ionic cordova build ios --prod --release
$ ionic cordova build ios --device --prod --release -- --developmentTeam="ABCD" --codeSignIdentity="iPhone Developer" --packageType="app-store"
$ ionic cordova build android
$ ionic cordova build android --prod --release -- -- --keystore=filename.keystore --alias=myalias
$ ionic cordova build android --prod --release -- -- --minSdkVersion=21
$ ionic cordova build android --prod --release -- -- --versionCode=55
$ ionic cordova build android --prod --release -- -- --gradleArg=-PcdvBuildMultipleApks=true
$ ionic cordova compile
编译本地平台的代码
命令
$ ionic cordova compile [<platform>]
明细
就像直接运行cordova compile,但是提供了友好的检查。
| 参数 | 描述 |
|---|
platform | 编译平台 (android, ios) |
| Option | Description |
|---|
--debug | 创建一个Cordova的调试构建 |
--release | 创建一个Cordova的版本 |
--device | 把Cordova编译成一个设备 |
--emulator | 将Cordova编译为模拟器 |
案例
$ ionic cordova compile ios
$ ionic cordova compile ios --device
$ ionic cordova compile android
$ ionic cordova emulate
模拟simulator或emulator的Ionic项目
命令
$ ionic cordova emulate[<platform>]
明细
就像直接运行cordova emulate一样,但也要关注web资产的变化,并提供与--livereload选项的实时重载功能。
与ionic cordova build一样,您可以使用--分隔符将附加选项传递给Cordova CLI。
| 参数 | 描述 |
|---|
platform | 平台模拟器(android, ios) |
| 选项 | 描述 |
|---|
--list | 列出所有可用的Cordova目标 |
--livereload, -l | 将服务器转到live-reload www文件 |
--consolelogs, -c | 将控制台日志打印到终端 |
--address | 为开发服务器使用特定的地址 |
--port, -p | 使用特定的HTTP端口 |
--livereload-port, -r | 使用特定端口进行重新加载 |
--dev-logger-port | 为dev服务器通信使用特定端口 |
--prod | 构建用于生产的应用程序 |
--aot | 为这个构建执行ahead-of-time编译 |
--minifyjs | 为这个构建提供Minify JS |
--minifycss | 为这个构建提供Minify CSS |
--optimizejs | 为这个构建执行JS优化 |
--debug | 标记为调试构建 |
--release | 标记发布为一个稳定版本 |
--device | 将Cordova部署到一个设备上 |
--emulator | 将Cordova部署到模拟器上 |
--target | 将Cordova构建到一个设备上 (用--list 来查看全部信息) |
--buildConfig | 使用指定的Cordova构建配置 |
案例
$ ionic cordova emulate
$ ionic cordova emulate ios
$ ionic cordova emulate ios -lc
$ ionic cordova emulate android -lc --address=localhost
$ ionic cordova emulate android -lc -- -d
$ ionic cordova platform
管理cordova的目标平台
命令
$ ionic cordova platform [<action>][<platform>]
明细
Like running cordova platform directly, but adds default Ionic icons and splash screen resources (during add) and provides friendly checks.
就像直接运行cordova平台,但添加了默认的ionic图标和splash screen(初始界面)资源(在添加过程中),并提供了友好的检查。
| 参数 | 描述 |
|---|
action | add, remove, 或 update a platform; ls, check, 或 save 所有的项目的平台 |
platform | 你想要添加的平台 (android, ios) |
| 选项 | 描述 |
|---|
--no-rsources | 不要预生成图标和启动屏幕资源 (对应 add) |
案例
$ ionic cordova platform
$ ionic cordova platform add ios
$ ionic cordova platform add android
$ ionic cordova platform rm ios
$ ionic cordova plugin
管理Cordova插件
命令
$ ionic cordova plugin [<action>][<plugin>]
明细
就像直接运行cordova插件一样,但是提供了友好的检查。
| 参数 | 描述 |
|---|
action | add 或 remove 一个插件; ls or save 所有项目的插件 |
plugin | 插件的名字 (对应 add and remove) |
| 选项 | 描述 |
|---|
--force | 如果存在,强制覆盖插件 (对应 add) |
--variable | 指定插件变量 |
案例
$ ionic cordova plugin
$ ionic cordova plugin add cordova-plugin-inappbrowser@latest
$ ionic cordova plugin add phonegap-plugin-push --variable SENDER_ID=XXXXX
$ ionic cordova plugin rm cordova-plugin-camera
打开App,阅读手记