create-sikit

A CLI tool to quickly create a new SIKit project with recommended setup and structure.

Usage

You can create a new SIKit project in one of the following ways:

# Using npx (recommended for one-time use)
npx create-sikit

# Using npm init
npm init sikit

# Using npm create (shorthand for init)
npm create sikit

The tool will prompt you for a project name and then:

1. Download the project template
2. Extract it to a new directory
3. Run CodeArtifact login (npm run co:login)
4. Install dependencies
5. Set up the project structure

Requirements

• Node.js 22.x or higher
• npm 6.x or higher
• AWS CodeArtifact access configured in the project template
• unzip command available on the system (used for extraction)

Implementation Details

This tool uses:

• Native Node.js fetch API for downloading templates
• Native file system operations for handling files
• Built-in unzip command line tool for extracting templates

No third-party dependencies are required for the core functionality.

Publishing to AWS CodeArtifact

To publish this package to AWS CodeArtifact:

1. Authenticate with AWS CodeArtifact:

   aws codeartifact login --tool npm --repository [your-repo] --domain [your-domain] --domain-owner [account-id]

2. Update the .npmrc file with the correct CodeArtifact URL.

3. Build the package:

   npm run build

4. Publish the package:

   npm publish

Development

To develop this CLI tool:

# Install dependencies
npm install

# Build the TypeScript files
npm run build

# Watch for changes during development
npm run dev

# Test the CLI locally
npm start