{"id":15297026,"url":"https://github.com/tipsi/tipsi-appium-helper","last_synced_at":"2025-10-07T10:30:48.283Z","repository":{"id":12649417,"uuid":"72450724","full_name":"tipsi/tipsi-appium-helper","owner":"tipsi","description":"Tipsi appium helper","archived":true,"fork":false,"pushed_at":"2023-01-04T02:13:23.000Z","size":1555,"stargazers_count":18,"open_issues_count":15,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-09-14T05:11:45.720Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tipsi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-31T15:35:55.000Z","updated_at":"2024-01-03T22:05:58.000Z","dependencies_parsed_at":"2023-01-11T19:30:51.801Z","dependency_job_id":null,"html_url":"https://github.com/tipsi/tipsi-appium-helper","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsi%2Ftipsi-appium-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsi%2Ftipsi-appium-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsi%2Ftipsi-appium-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsi%2Ftipsi-appium-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tipsi","download_url":"https://codeload.github.com/tipsi/tipsi-appium-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219877408,"owners_count":16554889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-30T19:14:34.394Z","updated_at":"2025-10-07T10:30:47.884Z","avatar_url":"https://github.com/tipsi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tipsi Appium Helper\n\n[![npm version](https://img.shields.io/npm/v/tipsi-appium-helper.svg?style=flat-square)](https://www.npmjs.com/package/tipsi-appium-helper)\n[![build status](https://img.shields.io/travis/tipsi/tipsi-appium-helper/master.svg?style=flat-square)](https://travis-ci.org/tipsi/tipsi-appium-helper)\n\n**Almost zero config helper to run tests with Appium**\n\n### Installation\n\n```sh\nnpm i tipsi-appium-helper --save-dev\n```\n\n### Usage\n\n```sh\nUsage: appium-helper [options]\n\nOptions:\n\n  -V, --version                     output the version number\n  -p, --platform [type]             platform name\n  -g, --glob [path]                 glob path for tests files\n  -d, --driver-config [path]        override default WebDriver config\n  -a, --app [path]                  path to application file\n  -H, --appium-host [host]          appium host\n  -P, --appium-port [port]          appium port\n  -D, --device-name [name]          device name\n  -V, --platform-version [version]  platform version\n  -A, --automation-name [name]      automation name\n  -N, --no-reset                    no reset\n  -F, --full-reset                  full reset\n  -R, --rc-file [path]              path to rc file (default .appiumhelperrc)\n  -r, --register [file...]          register\n  --playground                      playground\n  -h, --help                        output usage information\n```\n\n### Minimal setup\n\n1. Create your first test suite:\n\n   ```javascript\n   // ./__tests__/01_test_title.js\n\n   import test from 'tape-async'\n   import helper from 'tipsi-appium-helper'\n\n   const { driver, idFromText } = helper\n\n   test('Test if user can see title', async (t) =\u003e {\n     const titleId = idFromText('Welcome to React Native!')\n     await driver.waitForVisible(titleId, 60000)\n     const title = await driver.getText(titleId)\n     t.equal(title, 'Welcome to React Native!', 'Title is correct')\n   })\n   ```\n\n2. Run tests (in your package.json)\n\n   ```json\n   {\n     \"scripts\": {\n       \"test\": \"appium-helper --platform ios --glob ./__tests__/*_test_*.js --app ./example.app\"\n     }\n   }\n   ```\n\n   Internally `appium-helper` will check if Appium process is running. After that will check if iPhone Simulator is running, if not — will start default `iPhone 6` simulator with the `latest` avialable version of iOS.\n\n### Playground\nYou can run `tipsi-appium-helprer` in playgraund mode. This mode allows you to send command to `appium` via repl using `javascript` language and provides access to `helper` and `driver` instances.\n\nTo enter in this mode use `--playground` key:\n\n```bash\nappium-helper --platform ios --playground\n```\n\nSome useful special commands are supported by all repl:\n* `.clear` - resets the repl context to an empty object and clears any multi-line expression currently being input.\n* `.save` - save the current repl session to a file: `\u003e .save ./file/to/save.js`\n* `.load` - load a file into the current repl session. `\u003e .load ./file/to/load.js`\nFull commands list you can find [here](https://nodejs.org/api/repl.html#repl_commands_and_special_keys).\n\nPressed `\u003cctrl\u003e-C` twice to exit.\n\n#### Payground Example\n\n![playground](https://cloud.githubusercontent.com/assets/1177226/22211689/799da43c-e1c0-11e6-8e73-6151d8703610.gif)\n\n#### Differences in running tests for Android\n\nBefore run tests for Android you should start Android Emulator or connect your real device to your workstation. After that just check connected device via:\n\n```sh\n❯ adb devices\nList of devices attached\nemulator-5554\tdevice\n```\n\n`appium-helper` will select first connected android emulator in list.\n\nIf you want to specify an ID of android emulator you should use `--device-name` key:\n\n```json\n// package.json\n{\n  \"scripts\": {\n    \"test\": \"appium-helper --platform android --device-name emulator-5554\"\n  }\n}\n```\n\n#### How to specify an iOS Simulator\n\nIf you want to specify an iOS Simulator you can pass `--device-name` only parameter. In that case `appium-helper` will select an iPhone Simulator with the latest available version of iOS.\n\nIf you want to specify an iOS version of Simulator you should pass `--platform-version` key too:\n\n```sh\n// package.json\n{\n  \"scripts\": {\n    \"test:ios\": \"appium-helper --platform ios --device-name 'iPhone 7 Plus' --platform-version '10.1'\"\n  }\n}\n```\n\n### .appiumhelperrc\n\nYou can keep some config in `.appiumhelperrc` by default.\n\n```json\n{\n  \"testsGlob\": \"./__tests__/*_tests_*.js\",\n  \"appiumHost\": \"0.0.0.0\",\n  \"appiumPort\": \"4723\"\n}\n```\n\nYou can define platform-specific config params:\n\n```json\n{\n  \"ios\": {\n    \"appPath\": \"./ios/build/Build/Products/Release-iphonesimulator/example.app\",\n    \"noReset\": true\n  },\n  \"android\": {\n    \"appPath\": \"./android/app/build/outputs/apk/app-release.apk\"\n  }\n}\n```\n\nAlso you can specify a path to `./path/to/your/own/.whateveryouwantnamerc`:\n\n```sh\nappium-helper --rc-file ./__tests__/.testrc\n```\n\n### API\n\nComing soon…\n\n### Demo\n\n![appium_helper](https://cloud.githubusercontent.com/assets/1788245/21549249/fe10587c-ce01-11e6-8327-42e467efb65d.gif)\n\n### Tests\n\nTo run unit tests you can use `npm test` command.\n\n### License\n\nMIT License\n\nCopyright (c) 2016 Tipsi\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftipsi%2Ftipsi-appium-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftipsi%2Ftipsi-appium-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftipsi%2Ftipsi-appium-helper/lists"}