AWS Toolkit for Visual Studio Code

The AWS Toolkit for Visual Studio Code is an extension for working with AWS services such as AWS Lambda.

The toolkit is in preview and only available if built from source. This is pre-release software and we recommend against using it in a production environment.

This is an open source project because we want you to be involved. We love issues, feature requests, code reviews, pull requests or any positive contribution.

Getting Started

Install the toolkit

The toolkit has not been released to the marketplace, so in order to try it you must build and run from source:

Note: git and npm are required to build from source.

1. Clone the repository

git clone https://github.com/aws/aws-toolkit-vscode.git
cd aws-toolkit-vscode

2. Build and package the toolkit

npm install
npm run package

3. Install the toolkit

code --install-extension aws-toolkit-vscode-<VERSION>.vsix

Sign in to your AWS account

Create a profile

Method One: Create a profile using the AWS CLI

1. If you haven't already, sign up for AWS. You can create a free account here.
2. Install the AWS CLI by following the instructions here.
3. Run the command aws configure, and follow the instructions in the command prompt.

Method Two: Create a profile using the AWS Tools for PowerShell

1. If you haven't already, sign up for AWS. You can create a free account here.
2. Install the AWS Tools for PowerShell by following the instructions here.
3. Run the command Set-AWSCredential to define an AWS credential:

• On Mac or Linux:

  Set-AWSCredential -AccessKey [access-key-value] -SecretKey [secret-key-value] -StoreAs [profile-name]

• On Windows:

  Set-AWSCredential -AccessKey [access-key-value] -SecretKey [secret-key-value] -StoreAs [profile-name] -ProfileLocation $env:USERPROFILE\.aws\credentials

Method Three: Manually create a profile

1. If you haven't already, sign up for AWS. You can create a free account here.
2. Manually configure your configuration and credentials files as described here.

Select your profile in Visual Studio Code

1. Launch Visual Studio Code.
2. Select View > Command Palette... and search for AWS.
3. Select AWS: Connect to AWS

4. Select the profile that you created earlier.

Contributing

See Contributing.

License

The AWS Toolkit for Visual Studio Code is distributed under the Apache License, Version 2.0.