Skip to main content

​
Overview

LiteClient offers two storage scopes for your API data: Global and Workspace. Choose the scope that best fits your workflow and team collaboration needs.

​
Storage Scope Types

Global Storage

Data stored in VS Code’s global storage directory. Private to your machine, persists across all workspaces.

Workspace Storage

Data stored in .liteclient/ folder at workspace root. Can be shared via Git with your team.

​
Global Storage

By default, LiteClient stores all data in VS Code’s global storage directory.

​
Characteristics

  • Location: VS Code’s globalStorageUri (machine-specific path)
  • Scope: Private to your user account on this machine
  • Persistence: Available across all VS Code workspaces
  • Version Control: Not tracked in Git

​
When to Use Global Storage

Personal Projects

Working on solo projects where sharing isn’t needed

Private Credentials

Storing sensitive API keys you don’t want in repositories

Cross-Project APIs

Testing the same APIs across multiple projects

Local Development

Personal testing and development workflows

​
Workspace Storage

Introduced in version 0.13.0, workspace storage enables team collaboration by storing data in your project directory.

​
Characteristics

  • Location: .liteclient/ folder at workspace root
  • Scope: Specific to the current workspace
  • Persistence: Only available when this workspace is open
  • Version Control: Can be committed to Git for team sharing

​
Storage Files

When using workspace storage, LiteClient creates: 
workspace-root/
└── .liteclient/
    ├── collections.json     # Collections, folders, requests
    ├── environments.json    # Environments and variables
    ├── history.json         # Request execution history
    ├── cookies.json         # Cookie jar per domain
    └── settings.json        # User preferences

​
When to Use Workspace Storage

Team Collaboration

Share collections and environments with your team via Git

Project-Specific APIs

API configurations that belong to a specific project

Onboarding

New team members get API configs automatically when cloning

Documentation

API examples and test cases as part of project documentation
Avoid committing sensitive data to workspace storage. Use environment variables or VS Code’s SecretStorage for API keys and tokens.

​
Switching Storage Scopes

You can switch between global and workspace storage at any time.

​
Using the Status Bar

1

Find Storage Indicator

Look for the storage scope indicator in the VS Code status bar (bottom)
2

Click Indicator

Click the indicator showing Global or Workspace
3

Select New Scope

Choose your desired storage scope from the dropdown
4

Reload Workspace

LiteClient will reload and use the selected storage scope

​
Using Settings

Alternatively, configure via VS Code settings:
  1. Open Settings (Ctrl+, or Cmd+,)
  2. Search for liteclient.storageScope
  3. Select either global or workspace

​
Migrating Data to Workspace

If you’ve been using global storage and want to switch to workspace storage:
1

Open Command Palette

Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS)
2

Run Migration Command

Type and select: LiteClient: Migrate Data to Workspace
3

Confirm Migration

LiteClient copies your global data into .liteclient/ folder
4

Commit to Git

Add .liteclient/ to your repository:
git add .liteclient/
git commit -m "Add LiteClient API configurations"
Migration copies data from global storage. Your original global data remains unchanged.

​
File System Watcher

When using workspace storage, LiteClient automatically watches for external changes:
  • Detects changes to .liteclient/*.json files
  • Refreshes sidebar when files change externally
  • Useful after git pull or external edits
The file system watcher ensures your sidebar stays in sync when team members push collection updates.

​
Version Control Best Practices

When committing workspace storage to Git: 
# Ignore sensitive or user-specific files
.liteclient/settings.json
.liteclient/history.json

# Commit shared configurations
# .liteclient/collections.json
# .liteclient/environments.json
Recommended to commit: Contains API requests and folder structure. Useful for team sharing.
Conditional: Commit non-sensitive environment variables. Use template values (e.g., {{YOUR_API_KEY}}) for secrets.
Recommended to ignore: Personal request history varies by developer.
Recommended to ignore: Session cookies are user-specific and may contain sensitive data.
Recommended to ignore: User preferences are personal.

​
Comparison Table

FeatureGlobal StorageWorkspace Storage
LocationVS Code global directory.liteclient/ in workspace
SharingNot shareableGit-based team sharing
ScopeAll workspacesCurrent workspace only
Version ControlNoYes
File System WatcherNoYes
Use CasePersonal workflowsTeam collaboration

​
Troubleshooting

  • Verify the storage scope indicator shows the correct scope
  • Check that .liteclient/ folder exists in workspace root
  • Try reloading VS Code window
  • Run the migration command if switching from global to workspace
  • Ensure you’re using workspace storage scope
  • Check .gitignore isn’t excluding .liteclient/
  • Verify files exist: ls -la .liteclient/
  • Confirm workspace storage is active
  • Verify .liteclient/*.json files are committed
  • Ask team members to pull latest changes and reload VS Code
  • Check file system watcher is functioning