@corellium/corellium-cli 1.0.0 → 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/README.md +25 -38
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,46 +1,33 @@
1
1
  # corellium-cli
2
2
 
3
- ```
4
- git clone git@gitlab01.corellium.co:middleware/corellium-cli.git
5
- cd corellium-cli
6
- npm install
7
- npm link
8
- ```
3
+ Corellium CLI is a command line interface for Corellium's API. It allows you to manage your projects, devices and more from the command line. It is written in Node.js and uses the Corellium [Client API](https://www.npmjs.com/package/@corellium/client-api).
9
4
 
10
- *Note*: if you are running it locally create `.env` file and put the folliwing line there `NODE_TLS_REJECT_UNAUTHORIZED=0`
5
+ ## Installation
11
6
 
12
- ## Create subscriber Invite command
13
- **Usage**
14
- ```
15
- corellium signup --endpoint=https://app.ci-4.corellium.co --admin-user-name=admin --admin-password=password --user-password=userPassword --user-email=john.doe@gmail.com --customer-name=john01 --plan=individual-cloud-3-device --trial-duration=365
16
- ```
17
- ```
18
- Options:
19
- --help Show help [boolean]
20
- --version Show version number [boolean]
21
- --endpoint Server endpoint e.g. https://app.ci-4.corellium.co
22
- --admin-user-name Admin user
23
- --admin-password Admin password
24
- --user-email User email
25
- --user-password User password
26
- --customer-name Customer name. Use company name, unless customer is an individual.
27
- --plan Plan [choices: "individual-cloud-1-device", "individual-cloud-3-device", "individual-cloud-6-device", "enterprise-cloud-6-core", "enterprise-cloud-12-core", "enterprise-cloud-24-core", "individual-cloud-us
28
- age-based", "enterprise-cloud-usage-based"] [default: "individual-cloud-3-device"]
29
- --enterprise-domain Enterprise Domain name [default: ""]
30
- --trial-duration Trial duration. Default 7 days [number] [default: 7]
7
+ ```bash
8
+ npm install -g @corellium/cli
31
9
  ```
32
10
 
33
- ## Login
34
- ```
35
- corellium login
36
- ```
11
+ ## Development
37
12
 
38
- ## Upload extension
39
- ```
40
- corellium upload extension extension.zip
41
- ```
13
+ 1. Clone the repo
14
+ 2. Install dependencies: `npm install`
15
+ 3. Link with `npm link`
42
16
 
43
- ## Upload firmware
44
- ```
45
- corellium upload firmware firmware.zip
46
- ```
17
+ *Note*: if you are running it locally create `.env` file and put the following line there `NODE_TLS_REJECT_UNAUTHORIZED=0`
18
+
19
+ ## Example
20
+
21
+ ```bash
22
+ # Enter your details here first
23
+ $projectId="....."
24
+ $apiToken="......"
25
+
26
+ # Let there be virtual
27
+ corellium login --apitoken $apiToken --endpoint https://app.corellium.com
28
+ instanceId=$(corellium instance create iphone6 12.5.6 $projectId true)
29
+ corellium agent apps --project $projectId --instance $instanceId
30
+ corellium agent files --project $projectId --instance $instanceId
31
+ corellium instance stop $instanceId true
32
+ corellium instance delete $instanceId
33
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@corellium/corellium-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Corellium CLI Tool",
5
5
  "scripts": {
6
6
  "corellium-cli": "node index.js",