meet-simen/README.md

Get to know Simen via `npx meet-simen`

# `npx meet-simen`

> Get to know Simen using your command line with Node.js

## Usage

To use this CLI run the following command:

```sh
npx meet-simen
```

## Features

- 🚀 Modern TypeScript codebase
- 📦 Minimal dependencies
- 🎨 Colorful terminal output with Chalk
- 📊 GitHub stats integration
- 🔗 Social links and personal bio
- 📦 Beautiful boxed output with Boxen
- 📝 Interactive CV with work experience, skills, and projects
- 🔄 Remote data loading from GitHub (always up-to-date)
- 🧩 Modular architecture for easy maintenance
- 🎭 Interactive mode with step-by-step navigation

## Options

```
Usage: meet-simen [options]

Options:
  -V, --version       output the version number
  -b, --no-bio        Hide bio information
  -s, --no-social     Hide social links
  -a, --no-ad         Hide the ad
  -e, --no-experience Hide work experience
  -k, --no-skills     Hide skills
  -p, --no-projects   Hide projects
  -r, --remote        Load data from remote source (GitHub)
  -i, --interactive   Interactive mode (press Enter to navigate)
  -d, --debug         Show debug information
  --no-clear          Do not clear the console
  -h, --help          display help for command
```

## Data Customization

All CV data is stored in JSON files in the `src/data` directory:

- `bio.json` - Personal bio information
- `experience.json` - Work experience details
- `skills.json` - Technical skills
- `projects.json` - Notable projects
- `social.json` - Social media links
- `config.json` - Configuration settings

You can easily update these files to customize your CV without changing the code.

## Remote Data Loading

The CLI can load data directly from GitHub, allowing you to update your CV information without republishing the package. To use this feature:

1. Update the JSON files in your GitHub repository
2. Run the CLI with the `-r` or `--remote` flag

```sh
npx meet-simen --remote
```

## Development

This project uses TypeScript and npm for development.

### Setup

```sh
# Clone the repository
git clone https://github.com/Eventyret/meet-simen.git
cd meet-simen

# Install dependencies
npm install

# Run in development mode
npm run dev
```

### Building

```sh
# Build the project
npm run build
```

### Local Testing

To test the CLI locally, link it:

```sh
# Link the package
npm link

# Now you can run it
meet-simen
```

## Publishing

```sh
# Publish to npm
npm publish
```

## Requirements

- Node.js 16 or higher