Install

Installing dtsx is easy. Simply pull it in via your package manager of choice, or download the binary directly.

Package Managers

Choose your package manager of choice:

npm

npm install --save-dev @stacksjs/dtsx
# npm i -d @stacksjs/dtsx

# or, install globally via
npm i -g @stacksjs/dtsx

bun

bun install --dev @stacksjs/dtsx
# bun add --dev @stacksjs/dtsx
# bun i -d @stacksjs/dtsx

# or, install globally via
bun add --global @stacksjs/dtsx

pnpm

pnpm add --save-dev @stacksjs/dtsx
# pnpm i -d @stacksjs/dtsx

# or, install globally via
pnpm add --global @stacksjs/dtsx

yarn

yarn add --dev @stacksjs/dtsx
# yarn i -d @stacksjs/dtsx

# or, install globally via
yarn global add @stacksjs/dtsx

brew

brew install @stacksjs/dtsx # coming soon

pkgx

pkgx @stacksjs/dtsx # coming soon

Read more about how to use it in the Usage section of the documentation.

Binaries

Choose the binary that matches your platform and architecture:

macOS (arm64)

# Download the binary
curl -L https://github.com/stacksjs/dtsx/releases/download/v0.8.3/dtsx-darwin-arm64 -o dtsx

# Make it executable
chmod +x dtsx

# Move it to your PATH
mv dtsx /usr/local/bin/dtsx

macOS (x64)

# Download the binary
curl -L https://github.com/stacksjs/dtsx/releases/download/v0.8.3/dtsx-darwin-x64 -o dtsx

# Make it executable
chmod +x dtsx

# Move it to your PATH
mv dtsx /usr/local/bin/dtsx

Linux (arm64)

# Download the binary
curl -L https://github.com/stacksjs/dtsx/releases/download/v0.8.3/dtsx-linux-arm64 -o dtsx

# Make it executable
chmod +x dtsx

# Move it to your PATH
mv dtsx /usr/local/bin/dtsx

Linux (x64)

# Download the binary
curl -L https://github.com/stacksjs/dtsx/releases/download/v0.8.3/dtsx-linux-x64 -o dtsx

# Make it executable
chmod +x dtsx

# Move it to your PATH
mv dtsx /usr/local/bin/dtsx

Windows (x64)

# Download the binary
curl -L https://github.com/stacksjs/dtsx/releases/download/v0.8.3/dtsx-windows-x64.exe -o dtsx.exe

# Move it to your PATH (adjust the path as needed)
move dtsx.exe C:\Windows\System32\dtsx.exe

TIP

You can also find the dtsx binaries in GitHub releases.

Verification

After installation, verify that dtsx is working correctly:

# Check version
dtsx --version

# Show help
dtsx --help

# Test generation (in a TypeScript project)
dtsx --verbose

Requirements

System Requirements

• Node.js: Version 18 or higher (for npm package)
• Bun: Latest version recommended (for optimal performance)
• TypeScript: Version 5.0 or higher

Project Requirements

Your TypeScript project must have isolatedDeclarations enabled in tsconfig.json:

{
  "compilerOptions": {
    "isolatedDeclarations": true,
    "declaration": true
  }
}

Troubleshooting

Common Issues

1. Permission Denied (Binary Installation)

   # Make sure the binary is executable
   chmod +x dtsx

2. Command Not Found

   # Ensure the binary is in your PATH
   echo $PATH
   which dtsx

3. TypeScript Errors

   # Ensure isolatedDeclarations is enabled
   # Check your tsconfig.json file

Getting Help

If you encounter issues:

1. Check the troubleshooting guide
2. Search existing GitHub issues
3. Create a new issue with reproduction steps
4. Join our Discord community

Next Steps

After installation, check out:

• Usage Guide - Learn how to use dtsx
• Configuration - Customize dtsx for your project
• API Reference - Detailed API documentation
• Features - Explore advanced features