To install the extension, open the Extensions view, search for cloudsmith to filter results and select the Cloudsmith extension authorised by Cloudsmith.
-
Entitlement tokens are not supported.
-
Personal API Keys provide support for accessing mulitple Cloudsmith Workspaces if access is granted. A Service Account Token will provide access to a specific Workspace only.
Alternatively, you can install it via the .vsix file located on the repo releases. ( We recommend installing via the Marketplace. )
From the Extensions view in VS Code:
- Go to the Extensions view.
- Select Views and More Actions...
- Select Install from VSIX...
From the command line:
code --install-extension cloudsmith-x.x.x.vsix
code-insiders --install-extension cloudsmith-x-x-x.vsix
After installing, to connect to your Cloudsmith instance, you need to configure either your Personal API Key or a Service Account Token. Click on the key icon from the view menu and enter your credential into the input box. To connect press the connect or refresh icons.
A range of settings are configurable for the extension. See Overview for usage of these.
- Show Packages via individual Package or Package Group
- Inspect Output - choose where you want to send inspect output
- Maximum packages to show per repository. Max is limited to 30.
- Use Legacy Web App - URLs to Cloudsmith packages will use the legacy Web App instead.
The Cloudsmith extension contributes a Cloudsmith view to VS Code. The Cloudsmith Explorer lets you examine packages stored within your Cloudsmith assets: workspaces, repositories, packages.
By default the extension returns individual packages. You can display them as package groups instead.
A selection of important fields are available directly under a package. This will vary depending on package vs package group. This is a subset of the full api response schema for packages and groups. You can inspect the package to obtain the full response.
You can right-click on each detail and copy the value to the clipboard.
- Status
- Name
- Slug
- Slug Perm
- Number of downloads
- Version
- Tags
- Uploaded at date/time
- Count of packages in group
- Size
- Number of downloads
- Last pushed date/time
The right-click menu provides access to the following commands varying depending on whether you have enabled the package groups setting.
Selecting inspect will return the raw JSON data for the selected item. By default it will send the output to the Output window. You can configure for output to be sent to a new text document instead.
You can open the package directly in your Cloudsmith Web App.
- The number of returned packages is restricted to max 30 per repository. This can be configured to between 1-30 in the settings. Packages are sorted by last pushed in descending order.
- Authentication is currently restricted to API Key or Service Account Tokens.
- Initial release of the Cloudsmith extension. The extension provides a package explorer view into your Cloudsmith instance.
- Future releases will continue to build upon this with futher capabilities and features to closely match the Cloudsmith CLI.
Apache 2.0