https://github.com/ably-labs/vscode-ably

VSCode extension that allows management of Ably apps
https://github.com/ably-labs/vscode-ably

ably realtime vscode-extension

Last synced: about 1 year ago
JSON representation

VSCode extension that allows management of Ably apps

• Host: GitHub
• URL: https://github.com/ably-labs/vscode-ably
• Owner: ably-labs
• License: apache-2.0
• Created: 2022-03-01T12:50:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T10:47:11.000Z (almost 3 years ago)
• Last Synced: 2025-04-09T00:35:05.100Z (about 1 year ago)
• Topics: ably, realtime, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=ably-labs.vscode-ably
• Size: 6.49 MB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 57
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Ably for Visual Studio Code

![The Ably Apps Explorer](media/images/vscode-ably-applist.gif)

Use the *Ably for VS Code* extension to manage your Ably apps directly in VS Code.

The extension enables you to:

* List all apps in your Ably account.

  * View API keys, queues and integration rules for each app.

  * Copy API keys to your clipboard.

* Create an Ably app.

## Prerequisites

The only prerequisite is an [Ably account](https://ably.com/sign-up) which is free to sign-up.

## Installation

After installing this extension, you need to provide your Ably [account ID](https://ably.com/documentation/control-api#ids) and Control API [access token](https://ably.com/documentation/control-api#authentication) in VS Code **Settings** to get started. 

- Admin access to the Ably account is required to create a Control API access token.

- The Control API access token requires the following permissions:

   - read:app

   - write:app

   - read:key

   - read:rule

   - read:queue

![Image of Ably settings](media/images/vscode-ably-settings.gif)

> *In case the extension does not work after providing the AccountID and Control API access token, please restart VSCode.*

## Features

### View Ably apps & details

Click on the Ably icon in the **Activity Bar** to view the apps in your Ably account. Apps will be listed in alphabetical order.

Expand an app to view the API keys, queues, rules and namespaces associated with it.

![Image of an Ably app expanded](media/images/vscode-ably-applist.gif)

Use the *copy to clipboard* icon to copy an API key to the clipboard.

### Create an Ably app

1. Open the command palette (**CMD+SHIFT+P**) and choose `Ably: Create App`.

2. Enter a name for the app when prompted.

3. Select whether to enforce TLS for connections or not.

4. A new app will be created and appears in the list once the view has been automatically refreshed.

![Creation of an Ably App](media/images/vscode-ably-appcreate.gif)

## Issues & Features

If you find an issue 🪲 or have a feature request 🚀 please [file them here](https://github.com/ably-labs/vscode-ably/issues/new/choose).

Note that this extension is still in preview.

## Contributing

Want to help contributing to this project? Have a look at our [contributing guide](CONTRIBUTING.md)!

## More info

- [Ably on Twitter](https://twitter.com/ablyrealtime)

- [Ably SDKs](https://github.com/ably/)

- [Ably.com](https://ably.com)

---

![Ably logo](https://static.ably.dev/badge-black.png?ably-vscode)