Strapi SDK Plugin

https://github.com/strapi/sdk-plugin
Admin
Strapi SDK Plugin provides a comprehensive set of command-line tools and utilities for developing,...
Tokens:33,540
Snippets:464
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### runInstall usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Example of calling runInstall to execute npm install within a specific plugin directory.

```typescript
await runInstall('npm', './my-plugin');
// Runs: npm install (in ./my-plugin directory)
```

--------------------------------

### init usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Example of how to call the init function to initialize a plugin.

```typescript
import { init } from '@strapi/sdk-plugin/dist/utils/init';

const answers = await init({
  cwd: process.cwd(),
  path: './my-plugin',
  silent: false,
  debug: false,
  logger
});

// answers contains responses to all prompts
```

--------------------------------

### runPrompts usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Example of invoking runPrompts to gather configuration interactively.

```typescript
const answers = await runPrompts('my-plugin', gitConfig, false);

// answers[0] = { name: 'pkgName', answer: 'my-plugin' }
// answers[1] = { name: 'pluginId', answer: 'my-plugin' }
// ... etc
```

--------------------------------

### Start Strapi development server

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Commands to start the Strapi development server after linking the plugin.

```bash
yarn develop  # or npm run develop
```

--------------------------------

### Initialization with pnpm and skip install

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a plugin using pnpm while skipping the automatic dependency installation step.

```bash
strapi-plugin init my-plugin --use-pnpm --no-install
```

--------------------------------

### Initialization with npm

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a plugin and automatically installs dependencies using npm.

```bash
strapi-plugin init my-plugin --use-npm
```

--------------------------------

### Initialize CLI example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Basic usage of createCLI to initialize the CLI instance.

```typescript
import { createCLI } from '@strapi/sdk-plugin';

async function initializeCLI() {
  const cli = await createCLI(process.argv);
  // CLI is ready but not yet parsed/executed
  return cli;
}
```

--------------------------------

### Initialize a new plugin

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Use the init command to generate template files, configure the plugin, and install dependencies.

```bash
# Create new plugin
strapi-plugin init my-plugin

# This:
# - Prompts for configuration
# - Generates template files
# - Installs dependencies (if requested)
# - Shows Strapi setup instructions
```

--------------------------------

### logInstructions usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Example of calling logInstructions to generate configuration text for a TypeScript plugin.

```typescript
const instructions = logInstructions('my-plugin', {
  language: 'ts',
  path: './src/plugins/my-plugin'
});

logger.info(instructions);
```

--------------------------------

### Full package.json Example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

A complete example of a package.json file for a Strapi plugin, including exports, dependencies, and engine requirements.

```json
{
  "name": "@strapi/plugin-example",
  "version": "1.0.0",
  "description": "Example Strapi plugin",
  "author": {
    "name": "Your Name",
    "email": "your.email@example.com",
    "url": "https://strapi.io"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/strapi/plugins.git"
  },
  "license": "MIT",
  "type": "module",
  "exports": {
    "./strapi-admin": {
      "types": "./dist/admin/src/index.d.ts",
      "source": "./src/admin/index.ts",
      "import": "./dist/admin/index.mjs",
      "require": "./dist/admin/index.js",
      "default": "./dist/admin/index.js"
    },
    "./strapi-server": {
      "types": "./dist/server/src/index.d.ts",
      "source": "./src/server/index.ts",
      "import": "./dist/server/index.mjs",
      "require": "./dist/server/index.js",
      "default": "./dist/server/index.js"
    },
    "./package.json": "./package.json"
  },
  "files": [
    "dist"
  ],
  "dependencies": {
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
  },
  "peerDependencies": {
    "@strapi/strapi": "^5.0.0"
  },
  "devDependencies": {
    "@vitejs/plugin-react": "^5.2.0",
    "vite": "^6.4.2"
  },
  "engines": {
    "node": "^20.19.0 || >=22.12.0"
  }
}
```

--------------------------------

### Export ordering examples

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Examples demonstrating valid and invalid ordering of export properties within a package.json configuration.

```typescript
// Valid ordering
{
  "./strapi-admin": {
    "types": "./dist/admin/src/index.d.ts",      // First
    "source": "./src/admin/index.ts",
    "import": "./dist/admin/index.mjs",          // Before require
    "require": "./dist/admin/index.js",
    "default": "./dist/admin/index.js"           // Last
  }
}

// Invalid ordering
{
  "./strapi-admin": {
    "source": "./src/admin/index.ts",            // types not first!
    "types": "./dist/admin/src/index.d.ts",
    "require": "./dist/admin/index.js",          // require before import!
    "import": "./dist/admin/index.mjs",
    "default": "./dist/admin/index.js"
  }
}
```

--------------------------------

### loadPkg function usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Example of how to use loadPkg to retrieve the package.json content.

```typescript
const pkg = await loadPkg({
  cwd: process.cwd(),
  logger
});

console.log(pkg.name);  // Plugin name
```

--------------------------------

### runInstall

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Executes package installation for a created plugin using the specified package manager.

```APIDOC
## runInstall(packageManager, pluginPath)

### Description
Executes the package manager's install command within the specified plugin directory using verbose output.

### Parameters
- **packageManager** ('yarn' | 'npm' | 'pnpm') - Required - Package manager to use
- **pluginPath** (string) - Required - Plugin directory path

### Returns
- **Promise<void>**

### Example
```typescript
await runInstall('npm', './my-plugin');
```
```

--------------------------------

### findPackageJson usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Demonstrates how to use findPackageJson to locate the nearest package.json file starting from the current working directory.

```typescript
const pkgPath = await findPackageJson(process.cwd());

if (pkgPath) {
  console.log('Found:', pkgPath);
} else {
  console.log('No package.json found');
}
```

--------------------------------

### runAction usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Example demonstrating how to define an action and wrap it using runAction.

```typescript
const action = async (opts, _cmd, { logger }: CLIContext) => {
  logger.info('Doing something');
  // Do work
};

const wrapped = runAction('my-action', action);
// Usage: wrapped(ctx, options, cmd)
```

--------------------------------

### Prerequisites for yalc installation

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Alternative commands to install yalc globally using different package managers.

```bash
npm install -g yalc
# or
yarn global add yalc
# or
pnpm add -g yalc
```

--------------------------------

### writeFiles usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Example of calling writeFiles to generate plugin files at a specified path.

```typescript
await writeFiles(
  path.resolve(cwd, pluginPath),
  files,
  logger
);

// Creates ./my-plugin directory with all files
```

--------------------------------

### build function usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Example of calling the build function with specific options.

```typescript
import { build } from '@strapi/sdk-plugin/dist/utils/build';

await build({
  cwd: process.cwd(),
  logger,
  minify: true,
  sourcemap: true,
  silent: false,
  debug: false
});
```

--------------------------------

### Define bundle output paths

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Example configuration for bundle exports including source, import, require, and default paths.

```json
{
  "./strapi-admin": {
    "source": "./src/admin/index.ts",
    "import": "./dist/admin/index.mjs",
    "require": "./dist/admin/index.js",
    "default": "./dist/admin/index.js"
  }
}
```

--------------------------------

### Install yalc globally

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Prerequisite installation of yalc required for the watch:link command to function.

```bash
npm install -g yalc
```

--------------------------------

### Start watch:link in plugin directory

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Command to initiate the watch process in the plugin directory, followed by the expected output and instructions for linking in a Strapi project.

```bash
# Terminal 1: Start watch:link in plugin directory
npm run watch:link
```

```text
Watching dist for changes to files with extensions: ts,js,png,svg,gif,jpeg,css

To use this package in Strapi, in a separate shell run:
cd /path/to/strapi/project

Then run one of the commands below based on the package manager used in that project:

## yarn
yarn dlx yalc add --link @your-org/plugin-name && yarn install

## npm
npx yalc add @your-org/plugin-name && npx yalc link @your-org/plugin-name && npm install
```

--------------------------------

### watch function usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Example of calling the watch function.

```typescript
import { watch } from '@strapi/sdk-plugin/dist/utils/build/watch';

await watch({
  cwd: process.cwd(),
  logger,
  silent: false,
  debug: false
});
```

--------------------------------

### Server Plugin Export Configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Example configuration for the ./strapi-server export path.

```json
{
  "exports": {
    "./strapi-server": {
      "types": "./dist/server/src/index.d.ts",
      "source": "./src/server/index.ts",
      "import": "./dist/server/index.mjs",
      "require": "./dist/server/index.js",
      "default": "./dist/server/index.js"
    }
  }
}
```

--------------------------------

### Admin Panel Export Configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Example configuration for the ./strapi-admin export path.

```json
{
  "exports": {
    "./strapi-admin": {
      "types": "./dist/admin/src/index.d.ts",
      "source": "./src/admin/index.ts",
      "import": "./dist/admin/index.mjs",
      "require": "./dist/admin/index.js",
      "default": "./dist/admin/index.js"
    }
  }
}
```

--------------------------------

### loadTsConfig usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Demonstrates how to call loadTsConfig and handle the returned configuration or the case where it is not found.

```typescript
const tsConfig = loadTsConfig({
  cwd: process.cwd(),
  path: 'tsconfig.json',
  logger
});

if (tsConfig) {
  console.log('Config found at:', tsConfig.path);
} else {
  console.log('No tsconfig.json found');
}
```

--------------------------------

### parseGitConfig usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Example of retrieving and using the git configuration to access the user's name.

```typescript
const gitConfig = await parseGitConfig();

if (gitConfig?.user?.name) {
  console.log('Git user:', gitConfig.user.name);
}
```

--------------------------------

### pathExists usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Example showing how to use pathExists to verify the existence of a specific file path.

```typescript
const exists = await pathExists('./dist/admin/index.js');
console.log(exists ? '✓ File exists' : '✗ File missing');
```

--------------------------------

### Run CLI examples

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Various ways to invoke runCLI, including default arguments, custom arguments, and debug/silent modes.

```typescript
import { runCLI } from '@strapi/sdk-plugin';

// Run with process arguments (typical usage)
await runCLI();

// Run with custom arguments (testing, programmatic use)
await runCLI(['build', '--minify', '--sourcemap']);

// Run with debug output
await runCLI(['verify', '--debug']);

// Run silently
await runCLI(['build', '--silent']);
```

--------------------------------

### generateFiles usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

An example showing how to invoke generateFiles to retrieve an array of generated file objects.

```typescript
const files = await generateFiles(answers, 'my-plugin', logger);

// files[0] = { path: 'package.json', content: '...' }
// files[1] = { path: 'tsconfig.json', content: '...' }
// ... etc
```

--------------------------------

### runBuild usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Demonstrates how to invoke the runBuild function to execute a build command within a specific plugin directory.

```typescript
await runBuild('yarn', './my-plugin');
// Runs: yarn build (in ./my-plugin directory)
```

--------------------------------

### Yalc installation error message

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Error message displayed when yalc is not installed globally.

```text
Error: An error occurred. Make sure yalc is installed globally on your system. Exiting...
```

--------------------------------

### verify function usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Example of how to invoke the verify function within a try-catch block.

```typescript
import { verify } from '@strapi/sdk-plugin/dist/utils/validation';

try {
  await verify({
    cwd: process.cwd(),
    logger
  });
  console.log('✓ All checks passed');
} catch (error) {
  console.error('✗ Verification failed:', error.message);
  process.exit(1);
}
```

--------------------------------

### Global CLI options usage

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Examples of using global flags like --help, --debug, --silent, and --version via the CLI.

```bash
# Show help for build command
strapi-plugin build --help

# Run build with debug output
strapi-plugin build --debug

# Run build silently
strapi-plugin build --silent

# Show CLI version
strapi-plugin --version
```

--------------------------------

### Monitored Files Configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

Example of how source files are defined in package.json exports for monitoring.

```typescript
// Monitored files example
exports: {
  "./strapi-admin": {
    source: "./src/admin/index.ts"  // Watched
  },
  "./strapi-server": {
    source: "./src/server/index.ts"  // Watched
  }
}
```

--------------------------------

### formatBoxedErrorStack usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Example showing how to catch an error and format its stack trace for terminal output.

```typescript
try {
  // Some operation
} catch (error) {
  const formatted = await formatBoxedErrorStack(error.stack || '');
  console.log(formatted);
}
```

--------------------------------

### runInstall function signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

The function signature for executing package installation in a plugin directory.

```typescript
export const runInstall = async (
  packageManager: 'yarn' | 'npm' | 'pnpm',
  pluginPath: string
): Promise<void>
```

--------------------------------

### Init Command Workflow

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

The sequence of operations performed by the init command, starting from the init() function call through file generation and post-init execution.

```text
init command
  → init() function
    → parseGitConfig()
    → runPrompts()
    → generateFiles()
    → writeFiles()
  → Use answers for post-init steps
    → runInstall() and runBuild() if requested
    → Display Strapi setup instructions
```

--------------------------------

### Configure package.json exports

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Example of defining strapi-admin and strapi-server exports in package.json to resolve missing export errors.

```json
{
  "exports": {
    "./strapi-admin": { ... },
    "./strapi-server": { ... }
  }
}
```

--------------------------------

### Generic log method output

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/logger.md

Example of the output format for the generic log method.

```text
[2024-01-15T10:30:45.123Z]	message
```

--------------------------------

### checkExportFiles usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Example showing how to use checkExportFiles to validate package exports and handle potential errors.

```typescript
try {
  const missing = await checkExportFiles(pkg.exports, process.cwd());
  if (missing.length === 0) {
    console.log('✓ All exported files exist');
  }
} catch (error) {
  console.error('Missing files:', error.message);
  // Error shows paths like:
  // ./dist/admin/index.mjs -> /path/to/project/dist/admin/index.mjs
}
```

--------------------------------

### Logger output with timestamps

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/logger.md

Example of the default output format including timestamps for various log levels.

```text
[INFO]	[2024-01-15T10:30:45.123Z]  message
[DEBUG]	[2024-01-15T10:30:45.124Z]  debug message
[WARN]	[2024-01-15T10:30:45.125Z]  warning message
[ERROR]	[2024-01-15T10:30:45.126Z]  error message
```

--------------------------------

### Watch Mode Output

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

Example of the console output generated when the watch command is running.

```text
[INFO] Building plugin...
[INFO] Building admin bundle...
[INFO] admin bundle built successfully
[INFO] Building server bundle...
[INFO] server bundle built successfully
[INFO] Build complete!
```

--------------------------------

### getPkgManager usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Shows how to invoke getPkgManager with specific CLI options and project context.

```typescript
const pkgManager = getPkgManager(
  { useNpm: false, useYarn: true, usePnpm: false },
  true
);
// Returns: 'yarn'
```

--------------------------------

### Peer Dependencies Configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Example of declaring peer dependencies in package.json to specify supported Strapi versions.

```json
{
  "peerDependencies": {
    "@strapi/strapi": "^5.0.0"
  }
}
```

--------------------------------

### Prepare plugin for publishing

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Build the plugin with minification and verify the output before publishing to the registry.

```bash
# Build with minification
strapi-plugin build --minify

# Verify output
strapi-plugin verify

# If all checks pass, publish
npm publish
```

--------------------------------

### package.json Exports Configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Example configuration for the exports field in package.json, required for defining admin and server plugin bundles.

```json
{
  "exports": {
    "./strapi-admin": {
      "types": "./dist/admin/src/index.d.ts",
      "source": "./src/admin/index.ts",
      "import": "./dist/admin/index.mjs",
      "require": "./dist/admin/index.js",
      "default": "./dist/admin/index.js"
    },
    "./strapi-server": {
      "types": "./dist/server/src/index.d.ts",
      "source": "./src/server/index.ts",
      "import": "./dist/server/index.mjs",
      "require": "./dist/server/index.js",
      "default": "./dist/server/index.js"
    }
  }
}
```

--------------------------------

### formatBoxedErrorStack output example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

The visual representation of the formatted error stack trace in a terminal box.

```text
┌─────────────────────────────────────────┐
│                                         │
│  Error: Build failed                    │
│      at Object.<anonymous>              │
│      at Module._load (internal/modules) │
│                                         │
└─────────────────────────────────────────┘
```

--------------------------------

### Basic initialization

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a new plugin with the specified name.

```bash
strapi-plugin init my-plugin
```

--------------------------------

### Basic Build Command

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a standard build of the plugin.

```bash
strapi-plugin build
```

--------------------------------

### loadPkg

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

The loadPkg function searches for and loads the nearest package.json file starting from the specified directory.

```APIDOC
## loadPkg(options: { cwd: string, logger: Logger })

### Description
Loads the nearest package.json file by walking up the directory tree from the provided working directory.

### Parameters
- **options** (object) - Required
  - **cwd** (string) - Working directory to start search from.
  - **logger** (Logger) - Logger for debug output.

### Returns
- **Promise<object>** - Parsed package.json content as a plain object.

### Throws
- **Error** if no package.json is found or if the JSON is invalid.

### Example
```typescript
const pkg = await loadPkg({
  cwd: process.cwd(),
  logger
});

console.log(pkg.name); // Plugin name
```
```

--------------------------------

### findPackageJson

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Finds the nearest package.json file by walking up the directory tree from the provided starting path.

```APIDOC
## findPackageJson

### Description
Finds the nearest package.json by walking up the directory tree.

### Signature
`async findPackageJson(cwd: string): Promise<string | undefined>`

### Parameters
- **cwd** (string) - Required - Starting directory

### Returns
- **Promise<string | undefined>** - Absolute path to package.json or undefined if not found.

### Example
```typescript
const pkgPath = await findPackageJson(process.cwd());
```
```

--------------------------------

### dirContainsStrapiProject usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Demonstrates how to use dirContainsStrapiProject to determine if the current working directory is a Strapi project.

```typescript
const isStrapiProject = dirContainsStrapiProject(process.cwd());

if (isStrapiProject) {
  console.log('Running in a Strapi project');
  // Plugin will be created in ./src/plugins/
} else {
  console.log('Running standalone');
  // Plugin created in specified path
}
```

--------------------------------

### validatePkg usage example

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/validation-utilities.md

Demonstrates how to call validatePkg within a try-catch block to handle successful validation or catch ValidationError exceptions.

```typescript
try {
  const validated = await validatePkg({ pkg: rawPkg });
  console.log('Valid plugin package');
} catch (error) {
  console.error('Invalid package.json:', error.message);
  // Error message shows which field failed and why
}
```

--------------------------------

### Initialize New Strapi Plugin

Source: https://github.com/strapi/sdk-plugin/blob/main/README.md

Use the `init` command to create a new Strapi plugin project. Specify the desired path for the new plugin.

```bash
npx @strapi/sdk-plugin@latest init my-plugin
```

--------------------------------

### SpinnerHandle Interface

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/types.md

Interface for controlling a CLI spinner, providing methods to start, succeed, or fail a progress indicator.

```typescript
interface SpinnerHandle {
  text: string;
  succeed: (text?: string) => SpinnerHandle;
  fail: (text?: string) => SpinnerHandle;
  start: (text?: string) => SpinnerHandle;
}
```

--------------------------------

### Build with Minification

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a build with minification enabled for production readiness.

```bash
strapi-plugin build --minify
```

--------------------------------

### init(options: InitOptions)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

The main initialization function that creates a new plugin project by parsing the path, running configuration prompts, and generating the necessary files.

```APIDOC
## init(options: InitOptions)

### Description
Creates a new plugin project. It parses the plugin folder name, loads git configuration for defaults, runs interactive prompts (or uses defaults if silent), generates files, and writes them to disk.

### Parameters
- **options** (InitOptions) - Required
  - **cwd** (string) - Current working directory
  - **path** (string) - Target plugin path
  - **silent** (boolean) - Skip prompts and use defaults
  - **debug** (boolean) - Enable debug logging
  - **logger** (Logger) - Logger instance

### Returns
- **Promise<PromptAnswer[]>** - Array of user responses to prompts

### Example
```typescript
import { init } from '@strapi/sdk-plugin/dist/utils/init';

const answers = await init({
  cwd: process.cwd(),
  path: './my-plugin',
  silent: false,
  debug: false,
  logger
});
```
```

--------------------------------

### Verify command before publishing

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Standard workflow to build, verify, and publish a plugin.

```bash
strapi-plugin build
strapi-plugin verify
npm publish
```

--------------------------------

### Verify after build

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Workflow to build the plugin and then verify the output.

```bash
strapi-plugin build
strapi-plugin verify
```

--------------------------------

### package.json scripts

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Recommended scripts for building, watching, verifying, and linting the plugin.

```json
{
  "scripts": {
    "build": "strapi-plugin build",
    "watch": "strapi-plugin watch",
    "watch:link": "strapi-plugin watch:link",
    "verify": "strapi-plugin verify",
    "lint": "eslint .",
    "prettier:check": "prettier --check .",
    "prettier:write": "prettier --write ."
  }
}
```

--------------------------------

### logInstructions

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Generates formatted instructions for enabling a plugin in a Strapi project configuration file.

```APIDOC
## logInstructions(pluginName, options)

### Description
Generates instruction text for enabling a plugin in Strapi, supporting both JavaScript and TypeScript configuration formats.

### Parameters
- **pluginName** (string) - Required - Plugin ID (e.g., 'my-plugin')
- **options.language** ('js' | 'ts') - Required - Language of Strapi config
- **options.path** (string) - Required - Plugin path for resolve configuration

### Returns
- **string** - Formatted instruction text

### Example
```typescript
const instructions = logInstructions('my-plugin', {
  language: 'ts',
  path: './src/plugins/my-plugin'
});
```
```

--------------------------------

### strapi-plugin init

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a new Strapi plugin project at the specified path.

```APIDOC
## strapi-plugin init <path> [options]

### Description
Creates a new Strapi plugin project from a template at the specified path.

### Arguments
- **path** (string) - Required - Path where the plugin will be created.

### Options
- **--debug, -d** (boolean) - Optional - Enable verbose debug logging.
- **--silent** (boolean) - Optional - Suppress prompts and use defaults.
- **--use-npm** (boolean) - Optional - Use npm as the package manager.
- **--use-yarn** (boolean) - Optional - Use yarn as the package manager.
- **--use-pnpm** (boolean) - Optional - Use pnpm as the package manager.
- **--no-install** (boolean) - Optional - Skip automatic dependency installation.
```

--------------------------------

### runPrompts(suggestedPackageName, gitConfig, silent)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Runs interactive prompts to gather plugin configuration, including package details and feature selection.

```APIDOC
## runPrompts(suggestedPackageName, gitConfig, silent)

### Description
Runs interactive prompts to gather plugin configuration. If silent mode is enabled, it returns default values without prompting the user.

### Parameters
- **suggestedPackageName** (string) - Plugin name suggestion derived from the path
- **gitConfig** (GitConfig | null) - Git user configuration for default author fields
- **silent** (boolean) - If true, skips prompts and returns default values

### Returns
- **Promise<PromptAnswer[]>** - User responses to configuration prompts

### Example
```typescript
const answers = await runPrompts('my-plugin', gitConfig, false);
```
```

--------------------------------

### CLI entry point usage

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

The command-line syntax for invoking the strapi-plugin executable.

```bash
strapi-plugin [command] [options]
strapi-plugin init <path> [options]
strapi-plugin build [options]
strapi-plugin watch [options]
strapi-plugin watch:link [options]
strapi-plugin verify [options]
```

--------------------------------

### Logger output without timestamps

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/logger.md

Example of the output format when timestamps are disabled.

```text
[INFO]	message
[DEBUG]	debug message
[WARN]	warning message
[ERROR]	error message
```

--------------------------------

### Build with Minification and Source Maps

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a build combining both minification and source map generation.

```bash
strapi-plugin build --minify --sourcemap
```

--------------------------------

### Initialization with debug output

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a plugin while enabling verbose debug output for troubleshooting.

```bash
strapi-plugin init my-plugin --debug
```

--------------------------------

### Error: Missing package path

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Error message displayed when the package path is missing during initialization.

```text
Error: Missing package path
```

--------------------------------

### Recommended npm publish workflow

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

A sequence of commands to build, verify, and publish a plugin. The verify step ensures the output is correct before attempting to publish.

```bash
# 1. Build the plugin
npm run build

# 2. Verify output
npm run verify

# 3. If verify passes, publish
npm publish
```

--------------------------------

### Programmatic CLI Usage with @strapi/sdk-plugin

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Demonstrates how to execute CLI commands programmatically using runCLI or by manually creating and parsing a CLI instance.

```typescript
import { createCLI, runCLI } from '@strapi/sdk-plugin';

// Run CLI with custom arguments
await runCLI(['build', '--minify']);

// Or create and use manually
const cli = await createCLI(['build']);
await cli.parseAsync(['build']);
```

--------------------------------

### Server Entry Point (JavaScript)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Standard structure for the server entry point using JavaScript.

```javascript
module.exports = {
  register: ({ strapi }) => {},
  bootstrap: ({ strapi }) => {},
};
```

--------------------------------

### Build output directory structure

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Visual representation of the generated dist directory structure for admin and server bundles.

```text
dist/
  admin/
    index.js        # CommonJS
    index.mjs       # ESM
    src/
      index.d.ts    # TypeScript declarations
  server/
    index.js
    index.mjs
    src/
      index.d.ts
```

--------------------------------

### Build Strapi Plugin

Source: https://github.com/strapi/sdk-plugin/blob/main/README.md

Build your Strapi plugin package. Options include minifying the output and generating sourcemaps.

```bash
yarn run build
```

--------------------------------

### Initialization inside a Strapi project

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a plugin directly within the src/plugins directory of an existing Strapi project.

```bash
cd /path/to/strapi-project
strapi-plugin init my-plugin
# Creates at ./src/plugins/my-plugin
```

--------------------------------

### Plugin configuration output

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

The configuration snippet to add to ./config/plugins.js after successfully initializing a plugin.

```javascript
module.exports = {
  // ...
  'my-plugin': {
    enabled: true,
    resolve: './src/plugins/my-plugin'
  },
  // ...
}
```

--------------------------------

### Remove yalc link from Strapi

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Commands to remove the yalc link from a Strapi project and restore the original package installation.

```bash
cd /path/to/strapi
npx yalc remove @your-org/plugin-name
npm install
```

--------------------------------

### Run verify command

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Executes the verification process for the plugin.

```bash
strapi-plugin verify [options]
```

--------------------------------

### strapi-plugin init command signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

The basic command structure for initializing a new Strapi plugin at a specified path.

```bash
strapi-plugin init <path> [options]
```

--------------------------------

### Silent initialization

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-command.md

Initializes a plugin using default settings without interactive prompts.

```bash
strapi-plugin init my-plugin --silent
```

--------------------------------

### Build with Debug Logging

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a build with verbose output enabled for troubleshooting.

```bash
strapi-plugin build --debug
```

--------------------------------

### build(options: BuildOptions)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Orchestrates the plugin build process using Vite.

```APIDOC
## build(options: BuildOptions)

### Description
Orchestrates the plugin build process using Vite. It validates the package configuration, sets the environment, and executes the build for defined bundles.

### Parameters
- **options** (BuildOptions) - Required
  - **cwd** (string) - Required: Project root directory
  - **logger** (Logger) - Required: Logger instance
  - **minify** (boolean) - Optional: Minify output (default: false)
  - **sourcemap** (boolean) - Optional: Generate source maps (default: false)
  - **silent** (boolean) - Optional: Suppress output (default: false)
  - **debug** (boolean) - Optional: Enable debug logging (default: false)

### Returns
- **Promise<void>** - Resolves when build completes

### Throws
- **Error** if package.json is invalid
- **Error** if required exports missing
- Any error from Vite build process
```

--------------------------------

### Command Signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

The basic CLI usage pattern for the build command.

```bash
strapi-plugin build [options]
```

--------------------------------

### Basic Watch Command

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

Execute the watch command with default settings.

```bash
strapi-plugin watch
```

--------------------------------

### Watch and link for local testing with strapi-plugin watch:link

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Watches files and publishes the plugin via yalc to facilitate local testing within a Strapi project.

```bash
strapi-plugin watch:link
```

--------------------------------

### Build Options CLI Flags

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Use these flags with the strapi-plugin build command to control minification, source maps, and output verbosity.

```bash
# Minify bundles for production
strapi-plugin build --minify

# Generate source maps for debugging
strapi-plugin build --sourcemap

# Both minify and source maps
strapi-plugin build --minify --sourcemap

# Enable debug output
strapi-plugin build --debug

# Suppress all output
strapi-plugin build --silent
```

--------------------------------

### Initialize CLI with existing command instance

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Using createCLI with an existing Commander Command instance to register subcommands.

```typescript
import { createCLI } from '@strapi/sdk-plugin';
import { Command } from 'commander';

const rootCommand = new Command('my-cli');
const cli = await createCLI(process.argv, rootCommand);
// rootCommand now has all Strapi plugin subcommands registered
```

--------------------------------

### Run watch:link with pnpm

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Execute the watch:link command using the pnpm package manager.

```bash
pnpm watch:link
```

--------------------------------

### Optional Plugin Files

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Standard configuration and metadata files that can be included in a plugin project.

```text
my-plugin/
├── .editorconfig
├── .eslintrc.js
├── .prettierrc
├── .gitignore
├── README.md
├── LICENSE
├── package.json
├── tsconfig.json
├── src/
├── dist/
└── node_modules/
```

--------------------------------

### runBuild

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/helper-utilities.md

Executes the build command for a specified plugin using the chosen package manager.

```APIDOC
## runBuild

### Description
Executes the build command for the created plugin using the specified package manager.

### Signature
`async runBuild(packageManager: 'yarn' | 'npm' | 'pnpm', pluginPath: string): Promise<void>`

### Parameters
- **packageManager** ('yarn' | 'npm' | 'pnpm') - Required - Package manager to use
- **pluginPath** (string) - Required - Plugin directory path

### Example
```typescript
await runBuild('yarn', './my-plugin');
```
```

--------------------------------

### runCLI(argv, command)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Parses and executes the CLI, handling the complete command lifecycle including command registration and execution.

```APIDOC
## runCLI(argv, command)

### Description
Parses and executes the CLI, handling the complete command lifecycle. It calls createCLI() to set up commands and then executes the appropriate command via command.parseAsync().

### Parameters
- **argv** (string[]) - Optional - Command line arguments to parse (defaults to process.argv)
- **command** (Command) - Optional - Optional existing Command instance; if omitted, creates new one

### Returns
- **Promise<void>**
```

--------------------------------

### strapi-plugin watch [options]

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Watches source files and triggers automatic rebuilds.

```APIDOC
## strapi-plugin watch [options]

### Description
Watches source files and rebuilds automatically.

### Example
`strapi-plugin watch`
```

--------------------------------

### Basic watch:link workflow

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Standard workflow for linking a plugin to a Strapi project using two terminal sessions.

```bash
# Terminal 1 - Plugin directory
cd /path/to/plugin
npm run watch:link

# Terminal 2 - Strapi project
cd /path/to/strapi
npx yalc add @your-org/plugin-name
npx yalc link @your-org/plugin-name
npm install
npm run develop
```

--------------------------------

### strapi-plugin verify [options]

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Validates the package.json and exported files to ensure readiness for publishing.

```APIDOC
## strapi-plugin verify [options]

### Description
Validates package.json and exported files before publishing.

### Example
`strapi-plugin verify`
```

--------------------------------

### Server Entry Point (src/server/index.ts)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Defines the server-side entry point for the plugin, providing register and bootstrap functions for lifecycle hooks and initialization.

```typescript
// Example server plugin entry point
import type { Core } from '@strapi/strapi';

const register = ({ strapi }: { strapi: Core.Strapi }) => {
  // Register lifecycle hooks, services, etc.
};

const bootstrap = ({ strapi }: { strapi: Core.Strapi }) => {
  // Initialize plugin
};

export default {
  register,
  bootstrap,
};
```

--------------------------------

### Minimum package.json configuration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Defines the required exports for the strapi-admin and strapi-server bundles in the package.json file.

```json
{
  "name": "@your-org/strapi-plugin-name",
  "version": "1.0.0",
  "exports": {
    "./strapi-admin": {
      "types": "./dist/admin/src/index.d.ts",
      "source": "./src/admin/index.ts",
      "import": "./dist/admin/index.mjs",
      "require": "./dist/admin/index.js",
      "default": "./dist/admin/index.js"
    },
    "./strapi-server": {
      "types": "./dist/server/src/index.d.ts",
      "source": "./src/server/index.ts",
      "import": "./dist/server/index.mjs",
      "require": "./dist/server/index.js",
      "default": "./dist/server/index.js"
    }
  }
}
```

--------------------------------

### Verify with debug information

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Run verification with the --debug flag for verbose output.

```bash
strapi-plugin verify --debug
```

--------------------------------

### Command Signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

The basic syntax for executing the watch command.

```bash
strapi-plugin watch [options]
```

--------------------------------

### Error: Missing built files

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Error message displayed when expected build files are missing.

```text
Missing files for exports:
    ./dist/admin/index.mjs
```

--------------------------------

### Run watch:link with yarn

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Execute the watch:link command using the yarn package manager.

```bash
yarn watch:link
```

--------------------------------

### Development Workflow Usage

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

Standard workflow for using the watch command alongside a local Strapi project.

```bash
# Terminal 1: Watch plugin changes
strapi-plugin watch

# Terminal 2: Run Strapi locally
cd /path/to/strapi
npm run develop
```

--------------------------------

### init function signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

The main initialization function that creates a new plugin project.

```typescript
export const init = async (options: InitOptions): Promise<PromptAnswer[]>
```

--------------------------------

### Link plugin in Strapi project with npm

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Command to link the plugin in a Strapi project using npm.

```bash
npx yalc add @your-org/plugin-name && npx yalc link @your-org/plugin-name && npm install
```

--------------------------------

### Build with Source Maps

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a build while generating source maps for debugging purposes.

```bash
strapi-plugin build --sourcemap
```

--------------------------------

### Quiet Build

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-command.md

Run a build with all output suppressed.

```bash
strapi-plugin build --silent
```

--------------------------------

### Verify Strapi Plugin Output

Source: https://github.com/strapi/sdk-plugin/blob/main/README.md

Run the verify command to check the output of your plugin before publishing it.

```bash
yarn run verify
```

--------------------------------

### Admin Panel Entry Point (src/admin/index.ts)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Defines the admin panel entry point for the plugin, including the plugin ID, name, and registration logic.

```typescript
// Example admin plugin entry point
import React from 'react';
import { pluginId } from './pluginId';

const AdminPanel = () => (
  <div>My Plugin Admin Panel</div>
);

export default {
  id: pluginId,
  name: 'My Plugin',
  async registerPlugin() {
    return {
      id: pluginId,
      name: 'My Plugin',
      icon: 'puzzle',
      initializer: AdminPanel,
      injectedComponents: [],
    };
  },
};
```

--------------------------------

### Command Signature

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

The basic syntax for executing the watch:link command.

```bash
strapi-plugin watch:link [options]
```

--------------------------------

### Admin Entry Point (TypeScript)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Standard structure for the admin entry point using TypeScript.

```typescript
import type { Core } from '@strapi/strapi';

const register = ({ strapi }: { strapi: Core.Strapi }) => {};

const bootstrap = ({ strapi }: { strapi: Core.Strapi }) => {};

export default {
  register,
  bootstrap,
};
```

--------------------------------

### createCLI(argv, command)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/cli-interface.md

Creates a Commander.js CLI instance with all Strapi plugin commands registered. This is useful for programmatic access to the CLI structure.

```APIDOC
## createCLI(argv, command)

### Description
Creates a Commander.js CLI instance with all Strapi plugin commands registered. It loads the TypeScript configuration and sets up global options.

### Parameters
- **argv** (string[]) - Required - Command line arguments (e.g., process.argv)
- **command** (Command) - Optional - Optional existing Commander Command to attach to; if omitted, a new one is created

### Returns
- **Promise<Command>** - A Commander.js Command instance with all subcommands registered and ready for parsing
```

--------------------------------

### Add verify to package.json scripts

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Configure the prepublishonly script in package.json to automatically run the verify command before every npm publish.

```json
{
  "scripts": {
    "prepublishonly": "npm run verify"
  }
}
```

--------------------------------

### strapi-plugin watch:link [options]

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Watches and publishes the plugin via yalc for local Strapi testing.

```APIDOC
## strapi-plugin watch:link [options]

### Description
Watches and publishes via yalc for local Strapi testing.

### Example
`strapi-plugin watch:link`
```

--------------------------------

### Run watch:link with debug output

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Execute the watch:link command with debug logging enabled.

```bash
npm run watch:link -- --debug
```

--------------------------------

### createViteConfig

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Creates a Vite build configuration for a bundle based on the provided options.

```APIDOC
## createViteConfig

### Description
Creates a Vite build configuration for a bundle. This function returns an `InlineConfig` object ready to be passed to Vite's build function.

### Signature
`async function createViteConfig(options: ViteConfigOptions): Promise<InlineConfig>`

### Parameters
- **options** (ViteConfigOptions) - Required
  - **cwd** (string) - Current working directory.
  - **bundle** (BundleConfig) - The bundle configuration object.
  - **minify** (boolean) - Optional. Whether to minify the output.
  - **sourcemap** (boolean) - Optional. Whether to generate sourcemaps.
  - **silent** (boolean) - Optional. Whether to suppress output.
  - **target** (string) - Optional. Build target (e.g., 'es2020' for admin, 'node20' for server).

### Returns
- **InlineConfig** - The generated Vite configuration object.

### Configuration Details
- **Entry Points**: Resolves `bundle.source` to an absolute path; supports .ts, .tsx, .js, and .jsx files.
- **Output**: Supports CommonJS (index.js) and ES Module (index.mjs) formats based on bundle configuration.
- **Externalization**: `dependencies` and `peerDependencies` are excluded from the bundle, while `devDependencies` are included. Node built-in modules are always externalized.
```

--------------------------------

### watch(options: WatchOptions)

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Watches source files and triggers a rebuild on changes.

```APIDOC
## watch(options: WatchOptions)

### Description
Watches source files and rebuilds on changes. This function runs until the process is terminated.

### Parameters
- **options** (WatchOptions) - Required
  - **cwd** (string) - Required
  - **logger** (Logger) - Required
  - **silent** (boolean) - Optional
  - **debug** (boolean) - Optional

### Returns
- **Promise<void>**
```

--------------------------------

### InitOptions interface

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Configuration options for the init function.

```typescript
interface InitOptions {
  cwd: string;        // Current working directory
  path: string;       // Target plugin path
  silent: boolean;    // Skip prompts and use defaults
  debug: boolean;     // Enable debug logging
  logger: Logger;     // Logger instance
}
```

--------------------------------

### Watch with yalc for Local Testing

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-command.md

Workflow for testing plugin changes locally using yalc.

```bash
# Terminal 1: Watch with yalc
strapi-plugin watch:link

# Terminal 2: Test in Strapi project
cd /path/to/strapi
npx yalc add @your-org/plugin-name
npm run develop
```

--------------------------------

### writeFiles

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/init-utilities.md

Writes generated files to disk, creating necessary directory structures and preserving permissions.

```APIDOC
## writeFiles

### Description
Writes generated files to disk. It creates the directory structure if needed, writes each file, preserves permissions, and logs progress.

### Signature
`async writeFiles(fullPath: string, files: GeneratedFile[], logger: Logger): Promise<void>`

### Parameters
- **fullPath** (string) - Required - Absolute path where files go
- **files** (GeneratedFile[]) - Required - Files to write
- **logger** (Logger) - Required - Logger for output

### Example
```typescript
await writeFiles(
  path.resolve(cwd, pluginPath),
  files,
  logger
);
```
```

--------------------------------

### BuildOptions interface

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/build-utilities.md

Configuration options for the build function.

```typescript
interface BuildOptions {
  cwd: string;           // Project root directory
  logger: Logger;        // Logger instance
  minify?: boolean;      // Minify output (default: false)
  sourcemap?: boolean;   // Generate source maps (default: false)
  silent?: boolean;      // Suppress output (default: false)
  debug?: boolean;       // Enable debug logging (default: false)
}
```

--------------------------------

### strapi-plugin verify

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Validates the plugin configuration and build files.

```APIDOC
## strapi-plugin verify

### Description
Validates the plugin's package.json and build artifacts to ensure compliance with Strapi plugin requirements.

### Usage
`strapi-plugin verify [options]`

### Options
- **--debug** (flag) - Optional - Displays detailed validation information.
- **--silent** (flag) - Optional - Runs verification without standard output.

### Exit Codes
- **0** - All verifications passed.
- **1** - Any verification failed.
```

--------------------------------

### Full TypeScript plugin project structure

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Displays the comprehensive file layout for a full TypeScript plugin, including configuration files for build, linting, and formatting.

```text
my-plugin/
├── package.json
├── tsconfig.json
├── src/
│   ├── admin/index.ts
│   ├── server/index.ts
│   ├── components/
│   ├── utils/
│   └── ...
├── admin/tsconfig.build.json
├── server/tsconfig.build.json
├── .editorconfig
├── .eslintrc.js
├── .prettierrc
├── .gitignore
├── README.md
└── dist/
```

--------------------------------

### Verify command in continuous integration

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/verify-command.md

Use the verify command to fail a build if validation issues are detected.

```bash
strapi-plugin verify  # Fails build if issues found
```

--------------------------------

### Package manager commands

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/configuration.md

Commands to execute the defined package.json scripts.

```bash
npm run build      # Build plugin
npm run watch      # Watch for changes
npm run verify     # Verify before publishing
npm run lint       # Check code style
```

--------------------------------

### List yalc packages

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/api-reference/watch-link-command.md

Command to check the current yalc registry.

```bash
yalc list
```

--------------------------------

### Verify package integrity with strapi-plugin verify

Source: https://github.com/strapi/sdk-plugin/blob/main/_autodocs/README.md

Validates the package.json and exported files to ensure the plugin is ready for publishing.

```bash
strapi-plugin verify
```
Tokens:
Raw