appium-mcp 0.0.1 → 1.1.5

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-appiumconf2024.md

@@ -0,0 +1,45 @@
+---
+authors:
+  - srini
+  - sai
+date: 2024-07-13
+---
+
+# Appium Conf 2024: Call for Proposals Now Open!
+
+We're thrilled to announce that Appium Conf is back and going online for 2024! This is the official Appium conference where you can learn all about what's new in Appium 2.0 and explore the latest in automating tests for devices, mobile apps, and desktop applications.
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+    <a href="https://confengine.com/conferences/appium-conf-2024/proposals?utm_medium=referal&utm_source=appium.io&utm_campaign=launch">
+    <img id="image-36-42" alt="Appium Conf logo" src="https://appiumconf.com/wp-content/uploads/2021/06/Appium-Conf-Logo.svg" data-src="https://appiumconf.com/wp-content/uploads/2021/06/Appium-Conf-Logo.svg" decoding="async">
+</a>
+</div>
+
+## Mark Your Calendars: September 13, 2024
+
+Join us on September 13, 2024, for a full day of inspiring and practical talks from the Appium team and the world's top mobile testing and automation experts. With Appium 2.0 now well-established, this is your opportunity to dive deep and learn how to maximize its potential.
+
+## Why Attend Appium Conf 2024?
+
+1. **Gain Insights**: Hear interesting insights and inspiring case studies from global experts and the core Appium team.
+2. **Improve Your Strategy**: Gain valuable knowledge to enhance your own automation strategy.
+3. **Network**: Make connections with Appium users from around the globe.
+4. **Learn from Specialists**: Benefit from Appium specialists' expertise on a variety of topics.
+
+## Call for Proposals: Share Your Knowledge!
+
+We're looking for a diverse range of speakers from around the globe who are eager to share innovative ideas and use-cases of mobile test automation. If you have experience with Appium and insights that could benefit the community of test practitioners, we want to hear from you!
+
+Don't miss this chance to contribute to the Appium community and showcase your expertise on a global stage.
+
+## How to Submit Your Proposal
+
+Visit our website at [https://appiumconf.com/](https://appiumconf.com/) and [Submit a Proposal](https://confengine.com/conferences/appium-conf-2024/proposals?utm_medium=referal&utm_source=appium.io&utm_campaign=launch). We're excited to see your innovative ideas and experiences with Appium!
+
+## Stay Tuned
+
+Keep an eye on our website and social media channels for updates on the conference schedule, keynote speakers, and more exciting details about Appium Conf 2024.
+
+Join us in shaping the future of mobile and device test automation. Submit your proposal today and be part of this exciting event!

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-browserstack-as-strategic-partner.md

@@ -0,0 +1,46 @@
+---
+authors:
+  - jlipps
+date: 2024-06-10
+---
+
+# Announcing BrowserStack as Appium's Strategic Partner
+
+We have another exciting announcement for you! As part of our recently-announced sponsorship and
+contributor compensation
+program,
+we are obviously in need of significant funding to support giving back to our contributor
+community. We are therefore extremely happy to announce one of our brand new exclusive Strategic Partners: <a
+href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">BrowserStack</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-dark.png#only-dark" width="300" />
+    <img src="/docs/en/latest/assets/images/sponsor-logo-browserstack-light.png#only-light" width="300" />
+  </a>
+</div>
+
+BrowserStack has long been recognized in the industry as having extensive support for Appium,
+allowing you to run functional and visual regression tests for your native and hybrid apps at scale
+across a variety of devices and platforms.
+
+As a token of this collaboration, BrowserStack is extending a special premium access of
+BrowserStack App Automate product to Appium users. Discover more about this special offer at
+[browserstack.com](https://www.browserstack.com/browserstack-appium?utm_campaigncode=701OW00000AoUTQYA3&utm_medium=partnered&utm_source=appium&utm_term=partannouncement)
+
+With the decision to come on board as Strategic Partner, BrowserStack is making a huge investment
+in Appium and the Appium community. BrowserStack is very interested in supporting the development
+of the Appium contributor base, and is proud to be a key part of our contributor compensation
+scheme. Without Strategic Partners like BrowserStack, we would not be able to maintain such
+a program! We welcome them with gratitude!
+
+**About BrowserStack**
+
+<em>BrowserStack is the world’s leading software testing platform powering over two million tests every
+day across 19 global data centers. BrowserStack helps Tesco, Shell, NVIDIA, Discovery, Wells Fargo,
+and over 50,000 customers deliver quality software at speed by moving testing to their Cloud.
+BrowserStack’s platform provides instant access to 20,000+ real mobile devices on a highly reliable
+cloud infrastructure that effortlessly scales as testing needs grow. With BrowserStack, Dev and QA
+teams can move fast while delivering an amazing experience for every customer.</em>

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-headspin-as-development-partner.md

@@ -0,0 +1,47 @@
+---
+authors:
+  - jlipps
+date: 2024-06-06
+---
+
+# Announcing HeadSpin as Appium's Development Partner
+
+Recently, we announced a new [sponsorship and contributor compensation program](https://appium.io/docs/en/latest/blog/2024/05/14/announcing-appiums-sponsorship-program/) for the Appium
+project. As part of this program, we felt it was important to have a place to recognize those
+companies who make an extremely valuable kind of contribution to the project: dedicated maintainer
+time. Appium only survives because of the tireless efforts of the core maintainers, and some of us
+are only able to do this work because it is donated on behalf of our day jobs. We're therefore very
+excited to announce our first Development Partner: <a
+href="https://www.headspin.io/solutions/appium-mobile-test-automation">HeadSpin</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://www.headspin.io/solutions/appium-mobile-test-automation"><img
+src="/docs/en/latest/assets/images/sponsor-logo-headspin.png" style="width: 300px"/></a>
+</div>
+
+HeadSpin is a real device performance and UX analysis cloud, with full support for Appium. When you
+run your Appium tests on HeadSpin, you get access to comprehensive performance reports about your
+app, including potential network, system resource, or user experience issues. HeadSpin supports
+a variety of complex testing modes, including hooking up your own devices to the cloud, injecting
+and receiving video and audio to/from devices, working with media (streaming) platforms, and more.
+
+HeadSpin has been one of the Appium project's biggest supporters for a long time, and currently
+employs two of Appium's core maintainers, donating a significant portion of their time towards the
+development, maintenance, support, and leadership of open source Appium repos. HeadSpin has also
+worked hard towards Appium's vision of a robust Appium ecosystem, contributing several
+HeadSpin-maintained Appium drivers and plugins to the community:
+
+- A [Roku TV driver](https://github.com/headspinio/appium-roku-driver)
+- A [Tizen TV driver](https://github.com/headspinio/appium-tizen-tv-driver/)
+- A [LG webOS TV driver](https://github.com/headspinio/appium-lg-webos-driver/)
+- A [Unity game automation plugin](https://github.com/headspinio/appium-altunity-plugin)
+
+These are all free and open source Appium components that HeadSpin has donated to the community
+with the goal of fostering collaboration in these areas of media app automation.
+
+Looking to the future, HeadSpin plans to continue supporting Appium in significant ways, both as
+a Development Partner and a significant contributor to the Appium ecosystem. The Appium project is
+deeply indebted to HeadSpin for all of its support, and is proud to take this moment to recognize
+HeadSpin as our first official Development Partner!

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-lambdatest-as-strategic-partner.md

@@ -0,0 +1,41 @@
+---
+authors:
+  - jlipps
+date: 2025-07-01
+---
+
+# Announcing LambdaTest as Appium Strategic Partner
+
+After recently celebrating the 1-year anniversary of our Sponsorship Program and Compensation
+Scheme,
+the Appium project is very excited to announce that <a
+href="https://lambdatest.com/?utm_source=appium.io&utm_medium=organic&utm_campaign=june_25&utm_term=sk&utm_content=webpage">LambdaTest</a>
+is coming on board as one of our Strategic Partners!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%"><a href="https://lambdatest.com/?utm_source=appium.io&utm_medium=organic&utm_campaign=june_25&utm_term=sk&utm_content=webpage">
+    <img src="/docs/en/latest/assets/images/sponsor-logo-lambdatest-dark.png#only-dark" width="300" />
+    <img src="/docs/en/latest/assets/images/sponsor-logo-lambdatest-light.png#only-light" width="300" />
+  </a>
+</div>
+
+Having long been active in the Appium community and the automated testing industry, LambdaTest is
+now significantly stepping up their investment into these areas. With the decision to come on board
+as a Strategic Partner, LambdaTest will support the Appium project through financial contribution
+as well as contribution of code and project maintenance. Obviously, without the generous support of
+partners like LambdaTest, we would not be able to continue our contributor compensation scheme,
+which has seen the release of a substantial amount of funds to Appium maintainers and contributors
+over the last year. Thanks again to LambdaTest, and stay tuned for more collaboration updates
+throughout the year!
+
+**About LambdaTest**
+
+<em>LambdaTest is a GenAI-powered Quality Engineering Platform that empowers teams to test
+intelligently, smarter, and ship faster. Built for scale, it offers a full-stack testing cloud with
+10K+ real mobile devices and 3,000+ browsers. With AI-native test management, MCP servers, and
+agent-based automation, LambdaTest supports Selenium, Appium, Playwright, and all major frameworks.
+AI Agents like HyperExecute and KaneAI bring the power of AI and cloud into your software testing
+workflow, enabling seamless automation testing with 120+ integrations. LambdaTest Agents accelerate
+your testing throughout the entire SDLC, from test planning and authoring to automation,
+infrastructure, execution, RCA, and reporting.</em>

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sauce-labs-as-strategic-partner.md

@@ -0,0 +1,36 @@
+---
+authors:
+  - jlipps
+date: 2024-06-10
+---
+
+# Announcing Sauce Labs as Appium's Strategic Partner
+
+The good news surrounding our new sponsorship and contributor compensation
+program
+just keeps coming! Effective immediately we are fortunate and excited to be able to welcome a new Strategic Partner to
+the Appium project: <a href="https://saucelabs.com/resources/blog/appium-strategic-partner">Sauce Labs</a>!
+
+<!-- more -->
+
+<div style="text-align:center;width:100%">
+  <a href="https://saucelabs.com/resources/blog/appium-strategic-partner"><img src="/docs/en/latest/assets/images/sponsor-logo-sauce.png" style="width: 300px"/></a>
+</div>
+
+Sauce Labs has a long history of support for the Appium project. In fact, Appium was initially
+incubated at Sauce Labs under the direction of [@jlipps](https://github.com/jlipps), in the early
+days of mobile automation. Sauce Labs always envisioned Appium as being a project for and by the
+community, and cemented this perspective in 2016 with the donation of Appium to the JS Foundation
+(now the [OpenJS Foundation](https://openjsf.org/)). To this day, developers associated with Sauce
+Labs continue to help maintain various parts of the Appium project.
+
+Now, Sauce Labs is making a further commitment to support Appium financially as a way to enable
+our new contributor compensation program. We're very excited about this program as a vehicle for
+getting more people involved in Appium's development and maintenance. With the help of Strategic
+Partners like Sauce Labs, our project will be better able to meet the needs of our constantly
+growing userbase, and attract new developers (like you?) to build the Appium ecosystem together.
+Needless to say, we are extremely grateful for Sauce Labs's support!
+
+**About Sauce Labs**
+
+<em>Sauce Labs is the leader in continuous quality. Our Platform for Test helps organizations transform software testing from a chore to a competitive advantage. With decades of expertise and deep roots in the Selenium and Appium open source communities, high performing software teams use our platform to execute any testing workload across thousands of different devices, browsers, and operating systems—anywhere, any time, and at any scale. For more information, please visit [saucelabs.com](https://saucelabs.com).</em>

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sponsorship-program.md

@@ -0,0 +1,48 @@
+---
+authors:
+  - jlipps
+date: 2024-05-14
+---
+
+# Announcing Appium's Sponsorship Program
+
+Over the last several months, the Appium team has been working on a sponsorship program that is
+designed to help give back to Appium's contributors as well as to recognize important partner
+individuals or companies in the industry. This program is now officially launching! Let's dive into
+some of the details.
+
+<!-- more -->
+
+First of all, the details and fine print will always be available at Appium's Governance
+document, which outlines how the
+project is run, who makes project decisions, etc... This document will be kept up to date with the
+latest details of the program, so that's the place to bookmark for reference!
+
+As of now, Appium has opened up sponsorship opportunities via our OpenCollective
+page. OpenCollective is a service which allows people to donate
+to open source groups. We've defined a number of giving tiers for donations, within a very wide
+range, and welcome any financial amount with gratitude! Based on the donation tier, sponsorship
+comes with a variety of benefits, including recognition at different places in the Appium repo,
+docs, and website. In addition to financial sponsorship, the project has decided to recognize
+significant donations of project leadership and maintenance efforts from companies who have
+invested heavily into Appium with their employees' time (we call these "Development Partners").
+
+What will the project do with the funds raised through this sponsorship program? We aim to give it
+all back to the Appium community! With the details again available at our [Governance document](https://github.com/appium/appium/blob/master/GOVERNANCE.md),
+we have implemented a scheme very much inspired by our friends at [WebdriverIO](https://webdriver.io/blog/2024/02/15/new-contributor-stipend-program) (thanks WDIO
+friends!) There are three groups of contributors to Appium that this scheme supports: (1) project
+maintainers (those who devote consistent time to leading the project), (2) project contributors
+(anyone in the wider community that contributes code or documentation), and (3) upstream projects
+(other open source projects Appium relies heavily on to work well). Each month, the funds raised
+via sponsorship will be distributed in different amounts to each of these groups. So if you
+make a valuable contribution to Appium moving forward, you'll be eligible to get some cash as
+a thank-you! (You'll need to have your own OpenCollective account in good standing to receive
+funds).
+
+We're very excited about this new program, and hope that it helps existing and new contributors to
+feel even better about donating their time to making Appium better. And of course, none of this
+would be possible without the amazing Partners and Sponsors we hope to attract! On that note, stay
+tuned over the next few weeks as we unveil some of our initial program launch Partners! And if you
+or your company would like to participate by supporting Appium financially, you are most welcome.
+Just head over to our OpenCollective page and choose the tier that reflects your desired
+contribution level.

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/appium3.md

@@ -0,0 +1,40 @@
+---
+authors:
+  - sai
+  - srini
+  - jlipps
+date: 2025-08-07
+---
+
+# 🚀 Appium 3
+
+Appium 3 is here — and while it's not as massive a leap as Appium 2, it introduces a few essential
+breaking changes that developers and QA engineers should be aware of.
+
+<!-- more -->
+
+The main idea behind Appium 3 is to clear out old cruft so that Appium can be leaner moving
+forward, and rely on newer versions of software with better performance and security
+characteristics. We're also getting rid of legacy behaviors and protocols that we deprecated as
+part of Appium 2.
+
+For you as a user, there's not much to worry about. The breaking changes are minimal:
+
+- Node.js / NPM minimum version bump (to 20.19 / 10)
+- Removal of certain deprecated endpoints
+- Security feature flag prefix requirements (e.g. `adb_shell` to `uiautomator2:adb_shell`)
+
+In terms of new features, we've been adding them incrementally rather than saving them up for
+Appium 3. But with this release we are excited to share these new capabilities:
+
+- `appium plugin install inspector` (Use Appium to host the Inspector rather than downloading it as a separate app)
+- Clients can set the `X-Appium-Is-Sensitive` HTTP header on requests to direct the server to mask the data in the request in the logs, so that when you send a password into an input box, the password's actual value is not logged in plaintext. ([Learn more](../../developing/sensitive.md))
+
+Of course, we have a full [Appium 3 migration guide](../../guides/migrating-2-to-3.md) to make sure
+you know all the details and can deeply understand the consequences of upgrading to Appium 3 in
+your environment.
+
+---
+
+**Ready to make the leap?** Appium 3 is a great step forward in creating more secure, maintainable,
+and W3C-compliant test automation pipelines. Happy testing!

package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/hello-world.md

@@ -0,0 +1,15 @@
+---
+authors:
+  - jlipps
+date: 2024-03-07
+---
+
+# Hello World!
+
+This is the first post in the Appium blog. There's not much to see here yet. We're creating this
+space so we can make announcements or post other news, or information about events, that don't
+really fit inside the documentation itself.
+
+<!-- more -->
+
+Stay tuned for more!

package/src/resources/submodules/appium/packages/appium/docs/zh/contributing/index.md

@@ -0,0 +1,132 @@
+---
+hide:
+  - 导航栏
+
+title: 对Appium 的贡献
+---
+
+Appium项目离不开来自公司和志愿者的代码、文档、维护和支持的众多贡献。 因此，我们欢迎贡献！
+
+有许多不同的方式可以帮助项目——请参阅下方了解您可以做的一切以及每个贡献方法的流程。 请注意，无论您如何贡献，您的参与都受我们的[行为准则](https://github.com/appium/appium/blob/master/CONDUCT.md)管辖。
+
+## 加入讨论论坛
+
+您不需要了解Appium的内部机制就能做出贡献！ 如果您有使用Appium的经验，并愿意与他人分享您的知识，请考虑在Appium论坛[discuss.appium.io](https://discuss.appium.io/)上帮助用户。 快去看看是否有您能回答的问题。
+
+## 报告错误或功能请求
+
+如果您遇到了一个bug，或者有一个很酷的功能想法，认为Appium应该支持，请务必在我们的[GitHub issue tracker](https://github.com/appium/appium/issues)上告诉我们。
+请在创建issue时使用适当的issue表单模板。
+
+## 对问题分类
+
+除了创建issue，您还可以帮助我们调查已报告的问题。 您只需要对Appium有足够的熟悉程度来尝试重现bug。
+
+您可以通过检查我们的[GitHub issue tracker](https://github.com/appium/appium/issues)中带有标签如`Needs Triage`或`Needs Info`的问题开始，并留下相关评论：
+
+- 如果问题是重复的，请提供指向原始issue的链接
+- 如果用户没有提供足够的信息（如Appium日志），请向他们询问更多细节
+- 如果您能在自己的环境中重现问题，请提供您认为有助于我们追踪问题原因的所有信息
+
+有关对Appium问题进行分类的更多信息（适用于任何Appium项目仓库），请联系[技术委员会](https://github.com/appium/appium/blob/master/GOVERNANCE.md#the-technical-committee)的任何成员。
+
+## 贡献代码
+
+我们始终欢迎用于改进Appium代码或文档的拉取请求！
+
+!!! info
+
+    开发者信息可能不像面向用户的信息那样频繁更新，或者它在在线仓库中的当前形式可能最相关，而不是在这个发布的版本中。请务必检查仓库或与维护者讨论。我们很乐意帮助新贡献者入门！
+
+首先克隆仓库（我们建议先[fork](https://github.com/appium/appium/fork)
+它）：
+
+```sh
+git clone https://github.com/appium/appium.git
+cd appium
+```
+
+!!! info
+
+    如果您是 VS Code 用户，您可以使用  [Runme](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fappium%2Fappium.git&fileToOpen=packages%2Fappium%2Fdocs%2Fen%2Fcontributing%2Findex.md) 轻松地查看项目。
+
+安装依赖：
+
+```sh
+npm install
+```
+
+接下来你可以做几件事情。
+
+构建项目：
+
+```sh
+npm run build
+```
+
+构建项目并监视更改：
+
+```sh
+npm run dev
+```
+
+启动本地 Appium 服务器：
+
+```sh
+npm start
+```
+
+运行测试：
+
+```sh
+npm run lint
+npm run test:unit
+npm run test:types
+npm run test:smoke
+npm run test:e2e
+npm run test:quick # unit and types
+npm run test:slow # everything
+```
+
+您也可以运行特定工作区的测试，例如：
+
+```sh
+export APPIUM_WORKSPACE=@appium/base-driver
+npm run test:unit -w $APPIUM_WORKSPACE
+```
+
+### 文档
+
+此项目的文档位于项目[仓库本身](https://github.com/appium/appium/tree/master/packages/appium/docs)中。
+它包含在Markdown文件中，这些文件由`@appium/docutils`模块中的文档系统构建。 该模块基于[MkDocs](https://www.mkdocs.org/)，因此需要在您的系统上安装[Python](https://www.python.org/)。
+
+安装 Python 依赖：
+
+```sh
+npm run install-docs-deps
+```
+
+安装 Python 依赖：
+
+```sh
+npm run dev:docs
+```
+
+然后你可以在 `http://127.0.1:8000/docs/en` 中查看文档。
+
+## 翻译Appium 文档
+
+Appium文档本地化为英语以外语言的过程是自动化的，通过[Crowdin翻译管理系统](https://crowdin.com)完成。 请勿直接在GitHub Appium仓库中编辑任何翻译文档，因为它们将在即将进行的同步中被从Crowdin导出的文档替换。
+
+### 从哪里开始
+
+如果您想为Appium文档翻译成您的语言做出贡献，只需加入[Appium Documentation](https://crowdin.com/project/appium-documentation) Crowdin项目的翻译者组，然后在那里开始翻译文档。 如果您看到您的语言在Crowdin可用语言列表中缺失，请通过创建[issue](https://github.com/appium/appium/issues)告诉我们。
+
+### 源语言更新
+
+文档中的更改通过 `Update Crowdin English Docs GitHub` action自动同步到Crowdin。
+一旦 `packages/appium/docs/en/**.md` 或 `packages/appium/docs/mkdocs-en.yml` 下有任何更改，此action就会自动触发。
+
+### 获取翻译文档
+
+为了从Crowdin获取翻译文件到GitHub仓库，需要触发 `Sync Crowdin Docs Translations` action。 此action还会自动创建一个包含相应翻译资源的PR。

package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-docs.md

@@ -0,0 +1,86 @@
+---
+title: Building Documentation
+---
+
+Once you've [built a driver](./build-drivers.md) or [built a plugin](./build-plugins.md) for Appium,
+you will hopefully want to document how that extension works for your users. The most basic way of
+doing this is to write up a quick `README.md` and keep it in the root of your project's repository.
+However, this can involve a lot of effort.
+
+The Appium project has built tools to help with this, and we've packaged up these tools so our
+ecosystem developers building drivers and plugins can _also_ use them. The best way to get going
+with these tools is probably to look at an existing Appium driver repo to see how it's done, for
+example the [XCUITest driver repo](https://github.com/appium/appium-xcuitest-driver). But this guide
+will outline the basic approach.
+
+### Conceptual architecture
+
+Appium settled on [MkDocs](https://www.mkdocs.org/) as a Markdown-based documentation site
+generator. It uses a Python toolchain (and not Node.js), but it turned out to be the best option
+for our purposes. You can adjust this, but by default Appium's utilities also assume that you'll be
+using the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme/extension for
+MkDocs.
+
+In order to make different versions of your docs available (one for each minor release of your
+extension, typically), we also bundle [Mike](https://github.com/jimporter/mike).
+
+From here, building a basic docs site is as easy as collecting your Markdown files together and
+defining how you want them to be organized.
+
+### Prerequisites
+
+To take advantage of Appium's documentation utilities, you'll need to install:
+
+- [Python v3+](https://www.python.org/downloads/)
+- [pip](https://pip.pypa.io/en/stable/installation/) (this may be installed automatically with Python)
+- The `@appium/docutils` package:
+
+  ```bash
+  npm install --save-dev @appium/docutils
+  ```
+
+### Initializing an Extension for Building Docs
+
+To prepare your extension for generating documentation, run the following command:
+
+```bash
+npx appium-docs init
+```
+
+This will:
+
+1. Create a `tsconfig.json` if one does not already exist. This is necessary even if your extension
+   is not written in TypeScript.
+2. Create a `mkdocs.yml` with the necessary configuration for MkDocs.
+
+### Documenting Your Extension
+
+At this point, you can begin documenting your extension. By default, MkDocs will look for Markdown
+files in the `docs` directory. You can therefore create your Markdown documentation files, place
+them in `docs`, and add links to these files in `mkdocs.yml`.
+
+Refer to the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/) for
+information on how to organize and structure your documentation.
+
+### Building the Docs
+
+At this point, you can use the `appium-docs` CLI tool. Run this tool with no arguments to get the
+full help output and see all the available subcommands and parameters. Here are a few usage
+examples:
+
+```bash
+# Generate reference and build the mkdocs site into the site dir
+npx appium-docs build
+
+# Same as build, but host the docs on a local dev server
+# and watch for changes and rebuild when files change
+npx appium-docs build --serve
+
+# Build the docs and deploy them with mike versioning to the docs-site branch
+# using the included commit message.
+# This is particularly useful for pushing content to a GitHub pages branch!
+npx appium-docs build \
+  --deploy \
+  -b docs-site \
+  -m 'docs: auto-build docs for appium-xcuitest-driver@%s'
+```