Installation | Documentation

Get up and running with DevConsole in seconds. Choose your preferred package manager to install the debug toolkit.

Install the debug toolkit package using your preferred package manager. We recommend pnpm for the best performance.

bash

pnpm add devconsole-package

GitHub Authentication Setup

Since devconsole-package is hosted on a private GitHub repository, you'll need to authenticate before installation.

Option 1: GitHub CLI (Recommended)

bash

# Install GitHub CLI if needed
# macOS: brew install gh
# Or download from: https://cli.github.com/

# Authenticate
gh auth login

Option 2: Personal Access Token

bash

# 1. Create token at: https://github.com/settings/tokens
# 2. Use 'repo' scope
# 3. Configure git:
git config --global credential.helper store
echo "https://YOUR_TOKEN@github.com" >> ~/.git-credentials

Option 3: Helper Script

After installation, you can use the provided helper script:

bash

# Requires GITHUB_TOKEN environment variable
./node_modules/devconsole-package/scripts/setup-git-auth.sh

pnpm Configuration

Since devconsole-package is a git-hosted package that needs to run build scripts, you'll need to create a pnpm-workspace.yaml file in your project root to allow it.

yaml

# pnpm-workspace.yaml
# Allow build scripts for git-hosted dependencies
onlyBuiltDependencies:
  - "devconsole-package"

This configuration tells pnpm to allow the devconsole-package to run its build scripts during installation, which is required for the package to work properly.

Post-Install Cleanup (Optional)

To prevent recursive installs and reduce package size, you can use the provided cleanup script. This removes unnecessary files (source code, node_modules, etc.) from the installed package, keeping only the dist folder needed for runtime.

json

// In your package.json
{
  "scripts": {
    "postinstall": "node node_modules/devconsole-package/scripts/postinstall-cleanup.js"
  }
}

This is especially useful if you're experiencing slow installs or want to reduce disk usage.

CI/CD Deployment Setup

For deployments on Vercel or other platforms, you'll need to configure authentication:

1. Create GitHub Token

Create a Personal Access Token at https://github.com/settings/tokens with repo scope (read-only).

2. Add Environment Variable

Add GITHUB_TOKEN to your deployment platform:

Vercel: Settings → Environment Variables → Add GITHUB_TOKEN
Other platforms: Add GITHUB_TOKEN environment variable

3. Use Helper Script (Optional)

bash

# In your build script or vercel.json buildCommand:
./node_modules/devconsole-package/scripts/setup-git-auth.sh

Performance Tip: The package includes pre-built files in the repository, so installations are fast and don't require compilation. The build script only runs if the built files are missing.

Note: The package is designed to be lightweight and has zero runtime dependencies, ensuring your application stays fast.