Skip to main content

​
Installation

npm install -g @dotsetlabs/shield

​
Yarn

yarn global add @dotsetlabs/shield

​
pnpm

pnpm add -g @dotsetlabs/shield

​
Verify Installation

dotset --version

​
Requirements

  • Node.js 20 or later
  • npm, yarn, or pnpm

​
Project Setup

Shield is designed for zero-migration. If you use .env files, you can start using it immediately: 
cd your-project
dotset run -- npm start
If you want to use Shield’s native encrypted storage (required for cloud sync), initialize your project: 
dotset secrets init
When using native storage, add .dotset/key to your .gitignore immediately. This file contains your encryption key and should never be committed.

​
Updating

npm update -g @dotsetlabs/shield

​
Uninstalling

npm uninstall -g @dotsetlabs/shield