vscode-s3-fs

June 19, 2025 · View on GitHub

Mount an AWS S3 bucket or a specific prefix as a virtual filesystem in VS Code, enabling you to browse and edit S3 objects directly within the editor as if they were local files.

Features

  • Access S3 buckets or subdirectories via s3://bucket-name/optional/path/ URIs
  • Display files and directories in the VS Code Explorer pane
  • Common file operations: readFile, writeFile, copy, rename, delete, createDirectory
  • Pagination and retry built on AWS SDK v3 ListObjectsV2 API

Installation and Usage

  1. Install: search for vscode-s3-fs in the VS Code Marketplace and install, or download the VSIX and install manually via Extensions: Install from VSIX....

  2. Configure your AWS credentials and region in settings.json or via environment variables:

    {
      "s3FileSystem.awsAccessKeyId": "YOUR_ACCESS_KEY_ID",
      "s3FileSystem.awsSecretAccessKey": "YOUR_SECRET_ACCESS_KEY",
      "s3FileSystem.awsProfile": "default",
      "s3FileSystem.awsRegion": "us-west-2"
    }
    

    Or set environment variables:

    export AWS_ACCESS_KEY_ID=YOUR_ACCESS_KEY_ID
    export AWS_SECRET_ACCESS_KEY=YOUR_SECRET_ACCESS_KEY
    export AWS_PROFILE=default
    export AWS_REGION=us-west-2
    
  3. Open an S3 folder from the menu: File > Open Folder… and enter s3://my-bucket/optional/path/, or use Quick Open (Ctrl+P / Cmd+P).

Settings

SettingTypeDescription
awsAccessKeyIdstringAWS Access Key ID (static credentials)
awsSecretAccessKeystringAWS Secret Access Key (static credentials)
awsProfilestringAWS profile name (reads from ~/.aws/credentials)
awsRegionstringAWS region (fallbacks to AWS_REGION / AMAZON_REGION if not provided)

Known Limitations

  • watch is a no-op; S3 lacks push notifications for file changes.
  • Large files (>100MB) do not support multipart or streaming uploads.

Release Notes

v0.0.1

  • Initial release: basic mount, file operations, authentication, and pagination.