--- title: Getting Started with Insiders --- # Getting started with Insiders Welcome to Capawesome Insiders! You've joined **500+ development teams** who trust our plugins to build production apps. You now have access to 34+ professional Capacitor plugins that will save you weeks of development time. ## What You Get As an Insider, you get immediate access to: - **Full source code** for all 34+ Insider plugins (1M+ downloads/month) - **Complete documentation** with examples and guides - **Priority support** from official Ionic Developer Experts (tier-dependent) - **Regular updates** for new OS versions and features - **Breaking change support** and migration guides - **New plugins** added every other month [Browse all available plugins](index.md#available-sdks){ .md-button } ## Retrieve Your License Key License keys grant access to the private npm registry that hosts the Insider plugins. How you retrieve your key depends on how you subscribed: **Capawesome Cloud subscribers** — Manage license keys in the [Capawesome Cloud Console](https://console.cloud.capawesome.io/organizations/_/license-keys){:target="_blank"}. See [License keys](../cloud/license-keys.md) for details on creating, rotating, and managing keys. **Existing Polar customers** — Your license key is available in the [Polar Customer Portal](https://polar.sh/capawesome-team/portal){:target="_blank"}. Log in with the email address used for your subscription and copy the key from the "License Keys" section. **Keep your license key secure** — it provides access to the private npm registry. ## Quick Start Get started in under 2 minutes. Follow these steps to install your first Insider plugin: ### Step 1: Configure npm Registry Configure npm to use the Capawesome private registry: ```bash npm config set @capawesome-team:registry https://npm.registry.capawesome.io npm config set //npm.registry.capawesome.io/:_authToken ``` !!! warning "Replace the placeholder" Replace `` with your actual license key from the [Capawesome Cloud Console](https://console.cloud.capawesome.io/organizations/_/license-keys){:target="_blank"} or, for existing customers, the [Polar Customer Portal](https://polar.sh/capawesome-team/portal){:target="_blank"}. ### Step 2: Install a Plugin Install any Insider plugin using npm: ```bash npm install @capawesome-team/ npx cap sync ``` **Example:** To install the NFC plugin: ```bash npm install @capawesome-team/capacitor-nfc npx cap sync ``` ### Step 3: Import and Use Import the plugin in your code and start using it: ```typescript import { Nfc } from '@capawesome-team/capacitor-nfc'; // Start using the plugin const result = await Nfc.isSupported(); console.log('NFC supported:', result.isSupported); ``` That's it! Check each plugin's documentation for detailed API reference and examples. ## What's Next?
- :material-puzzle: **Explore Plugins** --- Browse the complete list of available Insider plugins and their capabilities. [View all plugins](index.md#available-plugins) - :material-book-open-variant: **Read Documentation** --- Each plugin has comprehensive documentation with examples and API reference. [Plugin documentation](../sdks/capacitor/index.md) - :material-chat-question: **Get Support** --- Need help? Access priority support via GitHub, Discord, or Email. [Learn about support](../support/index.md) - :material-rocket-launch: **CI/CD Setup** --- Set up Insider plugins in your CI/CD pipeline for automated builds. [View integrations](#cicd-configuration)
--- ## CI/CD Configuration Using Insider plugins in your CI/CD pipeline requires configuring the private npm registry with your license key. We provide step-by-step guides for popular platforms:
- :simple-github: **GitHub Actions** --- Configure GitHub Actions to access Insider plugins in your workflows. [View guide](integrations/github-actions.md) - :simple-gitlab: **GitLab CI/CD** --- Set up GitLab CI/CD pipelines with Insider plugin access. [View guide](integrations/gitlab-ci.md) - :material-microsoft-azure: **Azure DevOps** --- Configure Azure Pipelines for Insider plugin builds. [View guide](integrations/azure-devops.md) - :simple-bitbucket: **Bitbucket Pipelines** --- Enable Insider plugins in Bitbucket CI/CD. [View guide](integrations/bitbucket-pipelines.md) - :simple-ionic: **Ionic Appflow** --- Use Insider plugins with Ionic's cloud build service. [View guide](integrations/ionic-appflow.md) - :simple-vercel: **Vercel** --- Deploy apps using Insider plugins on Vercel. [View guide](integrations/vercel.md) - :simple-cloudflare: **Cloudflare Pages** --- Build and deploy with Insider plugins on Cloudflare. [View guide](integrations/cloudflare-pages.md) - :material-aws: **AWS Amplify** --- Configure AWS Amplify for Insider plugin builds. [View guide](integrations/aws-amplify.md) - :simple-jenkins: **Jenkins** --- Set up Jenkins pipelines with Insider plugin access. [View guide](integrations/jenkins.md)
--- ## Troubleshooting ### Common Issues **Authentication failed when installing plugins:** - Verify your license key is correct in the [Capawesome Cloud Console](https://console.cloud.capawesome.io/organizations/_/license-keys){:target="_blank"} or the [Polar Customer Portal](https://polar.sh/capawesome-team/portal){:target="_blank"} - Ensure you've configured both npm registry settings (registry URL and auth token) - Check that your subscription is active **Plugin not found:** - Make sure you're using the correct package name: `@capawesome-team/` - Verify your license hasn't expired (for perpetual licenses) **Need more help?** Contact our support team at [support@capawesome.io](mailto:support@capawesome.io) or visit our [support page](../support/index.md) for priority assistance. ## Bonus: Video Walkthrough Prefer to watch? This walkthrough covers getting started with Capawesome Insiders: