Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
@henchiyb
henchiyb committed Nov 7, 2023
1 parent 80a9080 commit 1db8b0d
Showing 1 changed file with 83 additions and 29 deletions.
112 changes: 83 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ See our official document: https://help.autify.com/docs/autify-command-line-inte
- [`autify web api describe-scenario`](#autify-web-api-describe-scenario)
- [`autify web api execute-scenarios`](#autify-web-api-execute-scenarios)
- [`autify web api execute-schedule`](#autify-web-api-execute-schedule)
- [`autify web api get-credit-usage`](#autify-web-api-get-credit-usage)
- [`autify web api get-project-info`](#autify-web-api-get-project-info)
- [`autify web api list-access-points`](#autify-web-api-list-access-points)
- [`autify web api list-capabilities`](#autify-web-api-list-capabilities)
- [`autify web api list-results`](#autify-web-api-list-results)
Expand Down Expand Up @@ -72,7 +74,7 @@ EXAMPLES
$ autify connect access-point create --name NAME --web-workspace-id ID
```

_See code: [src/commands/connect/access-point/create.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/access-point/create.ts)_
_See code: [src/commands/connect/access-point/create.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/access-point/create.ts)_

## `autify connect access-point set`

Expand All @@ -98,7 +100,7 @@ EXAMPLES
$ autify connect access-point set --name=NAME < key.txt
```

_See code: [src/commands/connect/access-point/set.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/access-point/set.ts)_
_See code: [src/commands/connect/access-point/set.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/access-point/set.ts)_

## `autify connect client install [VERSION]`

Expand Down Expand Up @@ -128,7 +130,7 @@ EXAMPLES
$ autify connect client install stable
```

_See code: [src/commands/connect/client/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/client/install.ts)_
_See code: [src/commands/connect/client/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/client/install.ts)_

## `autify connect client start`

Expand Down Expand Up @@ -162,7 +164,7 @@ EXAMPLES
$ autify connect client start --web-workspace-id 000
```

_See code: [src/commands/connect/client/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/client/start.ts)_
_See code: [src/commands/connect/client/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/client/start.ts)_

## `autify help [COMMANDS]`

Expand Down Expand Up @@ -203,7 +205,7 @@ EXAMPLES
$ autify mobile api describe-test-result
```

_See code: [src/commands/mobile/api/describe-test-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_
_See code: [src/commands/mobile/api/describe-test-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_

## `autify mobile api list-test-results`

Expand All @@ -227,7 +229,7 @@ EXAMPLES
$ autify mobile api list-test-results
```

_See code: [src/commands/mobile/api/list-test-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/list-test-results.ts)_
_See code: [src/commands/mobile/api/list-test-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/list-test-results.ts)_

## `autify mobile api run-test-plan`

Expand All @@ -248,7 +250,7 @@ EXAMPLES
$ autify mobile api run-test-plan
```

_See code: [src/commands/mobile/api/run-test-plan.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_
_See code: [src/commands/mobile/api/run-test-plan.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_

## `autify mobile api upload-build`

Expand All @@ -269,7 +271,7 @@ EXAMPLES
$ autify mobile api upload-build
```

_See code: [src/commands/mobile/api/upload-build.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/upload-build.ts)_
_See code: [src/commands/mobile/api/upload-build.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/upload-build.ts)_

## `autify mobile auth login`

Expand All @@ -292,7 +294,7 @@ EXAMPLES
$ autify mobile auth login < token.txt
```

_See code: [src/commands/mobile/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/auth/login.ts)_
_See code: [src/commands/mobile/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/auth/login.ts)_

## `autify mobile build upload BUILD-PATH`

Expand Down Expand Up @@ -326,7 +328,7 @@ EXAMPLES
$ autify mobile build upload --workspace-id AAA ./my.app --json
```

_See code: [src/commands/mobile/build/upload.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/build/upload.ts)_
_See code: [src/commands/mobile/build/upload.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/build/upload.ts)_

## `autify mobile test run TEST-PLAN-URL`

Expand Down Expand Up @@ -366,7 +368,7 @@ EXAMPLES
--timeout 600
```

_See code: [src/commands/mobile/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/test/run.ts)_
_See code: [src/commands/mobile/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/test/run.ts)_

## `autify mobile test wait TEST-RESULT-URL`

Expand All @@ -390,7 +392,7 @@ EXAMPLES
$ autify mobile test wait https://mobile-app.autify.com/projects/AAA/results/BBB
```

_See code: [src/commands/mobile/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/test/wait.ts)_
_See code: [src/commands/mobile/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/test/wait.ts)_

## `autify update [CHANNEL]`

Expand Down Expand Up @@ -449,7 +451,7 @@ EXAMPLES
$ autify web api create-access-point
```

_See code: [src/commands/web/api/create-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/create-access-point.ts)_
_See code: [src/commands/web/api/create-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/create-access-point.ts)_

## `autify web api create-url-replacement`

Expand All @@ -471,7 +473,7 @@ EXAMPLES
$ autify web api create-url-replacement
```

_See code: [src/commands/web/api/create-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/create-url-replacement.ts)_
_See code: [src/commands/web/api/create-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/create-url-replacement.ts)_

## `autify web api delete-access-point`

Expand All @@ -493,7 +495,7 @@ EXAMPLES
$ autify web api delete-access-point
```

_See code: [src/commands/web/api/delete-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/delete-access-point.ts)_
_See code: [src/commands/web/api/delete-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/delete-access-point.ts)_

## `autify web api delete-url-replacement`

Expand All @@ -515,7 +517,7 @@ EXAMPLES
$ autify web api delete-url-replacement
```

_See code: [src/commands/web/api/delete-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_
_See code: [src/commands/web/api/delete-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_

## `autify web api describe-result`

Expand All @@ -536,7 +538,7 @@ EXAMPLES
$ autify web api describe-result
```

_See code: [src/commands/web/api/describe-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/describe-result.ts)_
_See code: [src/commands/web/api/describe-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/describe-result.ts)_

## `autify web api describe-scenario`

Expand All @@ -557,7 +559,7 @@ EXAMPLES
$ autify web api describe-scenario
```

_See code: [src/commands/web/api/describe-scenario.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/describe-scenario.ts)_
_See code: [src/commands/web/api/describe-scenario.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/describe-scenario.ts)_

## `autify web api execute-scenarios`

Expand All @@ -580,7 +582,7 @@ EXAMPLES
$ autify web api execute-scenarios
```

_See code: [src/commands/web/api/execute-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/execute-scenarios.ts)_
_See code: [src/commands/web/api/execute-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/execute-scenarios.ts)_

## `autify web api execute-schedule`

Expand All @@ -602,7 +604,59 @@ EXAMPLES
$ autify web api execute-schedule
```

_See code: [src/commands/web/api/execute-schedule.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/execute-schedule.ts)_
_See code: [src/commands/web/api/execute-schedule.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/execute-schedule.ts)_

## `autify web api get-credit-usage`

Get the number of credits used in the project\ \ Notes:\ This endpoint works only for organizations on credit-based plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a run-based plan.

```
USAGE
$ autify web api get-credit-usage --project-id <value> [--date-from <value>] [--date-to <value>] [--scenario-id <value>]
[--test-plan-id <value>] [--user-id <value>]
FLAGS
--date-from=<value> The date to start counting used credits from.\ If not specified, the date will be set to 1
week ago.\ Up to 90 days in advance can be specified. If the specified date is more than 90
days in the past, the date will be set to 90 days ago.\ Date must follow the format YYYY-MM-DD
(example: &quot;2023-09-21&quot;).
--date-to=<value> The date to end counting used credits from.\ If not specified, the date will be set to today.\
Date must follow the format YYYY-MM-DD (example: &quot;2023-09-28&quot;).
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/credits
--scenario-id=<value> The scenario ID to filter used credits by.
--test-plan-id=<value> The test plan ID to filter used credits by.
--user-id=<value> The user ID that executed tests to filter used credits by.
DESCRIPTION
Get the number of credits used in the project\ \ Notes:\ This endpoint works only for organizations on credit-based
plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a
run-based plan.
EXAMPLES
$ autify web api get-credit-usage
```

_See code: [src/commands/web/api/get-credit-usage.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/get-credit-usage.ts)_

## `autify web api get-project-info`

Get project information.

```
USAGE
$ autify web api get-project-info --project-id <value>
FLAGS
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/project_info
DESCRIPTION
Get project information.
EXAMPLES
$ autify web api get-project-info
```

_See code: [src/commands/web/api/get-project-info.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/get-project-info.ts)_

## `autify web api list-access-points`

Expand All @@ -623,7 +677,7 @@ EXAMPLES
$ autify web api list-access-points
```

_See code: [src/commands/web/api/list-access-points.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-access-points.ts)_
_See code: [src/commands/web/api/list-access-points.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-access-points.ts)_

## `autify web api list-capabilities`

Expand All @@ -646,7 +700,7 @@ EXAMPLES
$ autify web api list-capabilities
```

_See code: [src/commands/web/api/list-capabilities.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-capabilities.ts)_
_See code: [src/commands/web/api/list-capabilities.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-capabilities.ts)_

## `autify web api list-results`

Expand All @@ -669,7 +723,7 @@ EXAMPLES
$ autify web api list-results
```

_See code: [src/commands/web/api/list-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-results.ts)_
_See code: [src/commands/web/api/list-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-results.ts)_

## `autify web api list-scenarios`

Expand All @@ -690,7 +744,7 @@ EXAMPLES
$ autify web api list-scenarios
```

_See code: [src/commands/web/api/list-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-scenarios.ts)_
_See code: [src/commands/web/api/list-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-scenarios.ts)_

## `autify web api list-url-replacements`

Expand All @@ -711,7 +765,7 @@ EXAMPLES
$ autify web api list-url-replacements
```

_See code: [src/commands/web/api/list-url-replacements.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-url-replacements.ts)_
_See code: [src/commands/web/api/list-url-replacements.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-url-replacements.ts)_

## `autify web api update-url-replacement`

Expand All @@ -736,7 +790,7 @@ EXAMPLES
$ autify web api update-url-replacement
```

_See code: [src/commands/web/api/update-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/update-url-replacement.ts)_
_See code: [src/commands/web/api/update-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/update-url-replacement.ts)_

## `autify web auth login`

Expand All @@ -759,7 +813,7 @@ EXAMPLES
$ autify web auth login < token.txt
```

_See code: [src/commands/web/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/auth/login.ts)_
_See code: [src/commands/web/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/auth/login.ts)_

## `autify web test run SCENARIO-OR-TEST-PLAN-URL`

Expand Down Expand Up @@ -838,7 +892,7 @@ EXAMPLES
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --autify-connect-client
```

_See code: [src/commands/web/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/test/run.ts)_
_See code: [src/commands/web/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/test/run.ts)_

## `autify web test wait TEST-RESULT-URL`

Expand All @@ -862,6 +916,6 @@ EXAMPLES
$ autify web test wait https://app.autify.com/projects/0000/results/0000
```

_See code: [src/commands/web/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/test/wait.ts)_
_See code: [src/commands/web/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/test/wait.ts)_

<!-- commandsstop -->

0 comments on commit 1db8b0d

Please sign in to comment.