Client Tools

PicFast provides a flat upload endpoint at /api/v1/flat/upload that returns a clean JSON response — ideal for third-party upload clients. All tools below use this same endpoint.

VS Code Extension

The official PicFast Image Uploader extension (atbeta.picfast) lets you upload images directly from VS Code. Install it from the VS Code Marketplace.

Features

  • CodeLens — a clickable upload link appears above every local image reference in .md and .mdx files
  • Bulk upload — right-click in a file and select "Upload All Local Images" to batch-upload and replace every reference at once
  • Keyboard shortcutsCtrl+Alt+U / Cmd+Alt+U for bulk upload, Ctrl+Alt+V / Cmd+Alt+V for single upload
  • Bilingual UI (English + Simplified Chinese)

Configuration

In VS Code settings (Ctrl+, / Cmd+,):

{
  "picfast.baseUrl": "https://picfast.example.com",
  "picfast.apiToken": "img_xxxxxxxx"
}

If picfast.apiToken is omitted, the extension operates in guest mode (requires guest upload to be enabled on your instance).

CLI

The picfast CLI lets you upload images from the terminal. Install it via npm:

npm install -g picfast

Or run without installing:

npx picfast screenshot.png

Usage

# Set your server URL and API token
picfast config set url "https://picfast.example.com"
picfast config set token "img_xxxxxxxx"

# Upload an image
picfast screenshot.png

# Output as Markdown
picfast --format markdown screenshot.png

# Output as Markdown (short flag)
picfast -m screenshot.png

The CLI supports darwin, linux, and windows on both amd64 and arm64. The npm package auto-downloads the right binary for your platform on install. The npm package is picfast.

PicGo / PicList

  1. Install PicGo or PicList, then install the web-uploader plugin from the plugin settings.
  2. In image host settings, choose Custom Web Image Host and paste the config below.
{
  "picBed": {
    "uploader": "picgo-plugin-web-uploader",
    "picgo-plugin-web-uploader": {
      "url": "https://picfast.example.com/api/v1/flat/upload",
      "paramName": "file",
      "jsonPath": "url",
      "customHeader": "{\"Authorization\": \"Bearer <YOUR_API_TOKEN>\"}"
    }
  }
}

uPic

In uPic, choose Custom as the image host and fill in:

FieldValue
URLhttps://picfast.example.com/api/v1/flat/upload
MethodPOST
File Fieldfile
HeaderAuthorization: Bearer <YOUR_API_TOKEN>
URL Path["url"]
Domainhttps://picfast.example.com

Dropshare

In Dropshare, choose Custom API connection:

FieldValue
Upload URLhttps://picfast.example.com/api/v1/flat/upload
MethodPOST
Content Typemultipart/form-data
Form Fieldfile
Header{"Authorization": "Bearer <YOUR_API_TOKEN>"}
Response Content TypeJSON
URL to file%url%

Obsidian

Install the community plugin Image auto upload and select PicGo as the upload service. Images pasted into notes are automatically uploaded to PicFast and replaced with the returned URL.

API token

Create an API token in the PicFast admin console under Settings → API Tokens. Tokens are prefixed img_ and support scoped permissions (e.g. upload-only). Use the token in the Authorization: Bearer header for all tools above.