cliex 0.1.0__tar.gz

cliex-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,45 @@
+# GitHub Actions — runs when a version tag is mirrored from GitLab to GitHub.
+# Creates a GitHub Release and attaches wheel + sdist for users who install from Releases.
+#
+# Enable: GitHub repo → Settings → Actions → General → Allow all actions.
+
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build package
+        run: |
+          pip install flit
+          python -m flit build
+          ls -la dist/
+
+      - name: Verify package
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          prerelease: false

cliex-0.1.0/.gitignore

@@ -0,0 +1,92 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+test/.venv/
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pytype/
+
+# Linters / formatters
+.ruff_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# Environments & secrets
+.env
+.env.*
+!.env.example
+
+# IDE / editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+Thumbs.db
+Desktop.ini
+
+# Logs
+*.log
+
+# Local scratch / temp
+tmp/
+temp/
+*.tmp

cliex-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,77 @@
+# GitLab CI — test on main branch only; publish to PyPI when a version tag is pushed.
+# Tag format: v0.1.0 (must match version in pyproject.toml)
+#
+# Required CI/CD variable (Settings → CI/CD → Variables):
+#   PYPI_API_TOKEN — PyPI API token (scope: entire account or project "cliex")
+
+stages:
+  - test
+  - build
+  - release
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+
+cache:
+  key: "${CI_COMMIT_REF_SLUG}"
+  paths:
+    - .cache/pip
+
+.test_template: &test_template
+  stage: test
+  image: python:3.11
+  before_script:
+    - python --version
+    - pip install flit
+    - pip install -e .
+  script:
+    - python -c "import cliex; print('version:', cliex.__version__)"
+    - python -m cliex list
+
+test:branch:
+  <<: *test_template
+  rules:
+    - if: $CI_COMMIT_TAG
+      when: never
+    - if: $CI_COMMIT_BRANCH == "main"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"
+
+test:tag:
+  <<: *test_template
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
+
+build:
+  stage: build
+  image: python:3.11
+  script:
+    - pip install flit
+    - python -m flit build
+    - ls -la dist/
+  artifacts:
+    paths:
+      - dist/
+    expire_in: 4 weeks
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
+
+publish:pypi:
+  stage: release
+  image: python:3.11
+  needs:
+    - job: build
+      artifacts: true
+  script:
+    - pip install twine
+    - twine check dist/*
+    - >
+      twine upload dist/*
+      --username __token__
+      --password "$PYPI_API_TOKEN"
+      --non-interactive
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/
+  environment:
+    name: pypi
+    url: https://pypi.org/project/cliex/

cliex-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DucHuynhTrung
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cliex-0.1.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: cliex
+Version: 0.1.0
+Summary: CLI tool setup project quickly.
+Author-email: DucHuynhTrung <huynhtrungduc.growth@gmail.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+License-File: LICENSE
+Requires-Dist: typer[all]>=0.12.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pyyaml>=6.0
+Project-URL: Bug Tracker, https://github.com/DucHuynhTrung/cliex-quick/issues
+Project-URL: Documentation, https://github.com/DucHuynhTrung/cliex-quick#readme
+Project-URL: Homepage, https://github.com/DucHuynhTrung/cliex-quick
+Project-URL: Repository, https://github.com/DucHuynhTrung/cliex-quick.git
+
+# Cliex
+
+**Cliex** is a Python CLI tool that helps you bootstrap projects quickly using **setup profiles** defined in YAML. Instead of retyping dozens of install commands every time you start a new project, you run one command — Cliex executes the entire setup workflow for you.
+
+The source code is **free and open** for the community. You may use, modify, and share it freely under the MIT license.
+
+## Features
+
+- Bootstrap a new project with a single command
+- Support for multiple setup profiles (Next.js, FastAPI, Razor, etc.)
+- Create or customize your own profiles via YAML files
+- List and manage available profiles
+- Colorful terminal output for easy progress tracking
+- Automatic checks for required tools before running
+
+## Requirements
+
+- Python 3.11+
+- Node.js, npm, npx (for frontend profiles such as Next.js)
+- Git
+
+## Installation
+
+### Option 1 — PyPI (recommended for end users)
+
+Requires Python 3.11+.
+
+```bash
+# Recommended: isolated install
+pipx install cliex
+
+# Or with pip
+pip install cliex
+```
+
+Verify:
+
+```bash
+cliex list
+```
+
+**Update to the latest version:**
+
+```bash
+pipx upgrade cliex
+# or
+pip install -U cliex
+```
+
+### Option 2 — GitHub Releases
+
+Download a wheel from [Releases](https://github.com/DucHuynhTrung/cliex-quick/releases) or install directly:
+
+```bash
+pip install https://github.com/DucHuynhTrung/cliex-quick/releases/download/v0.1.0/cliex-0.1.0-py3-none-any.whl
+```
+
+Replace `v0.1.0` with the latest tag.
+
+### Option 3 — Install from source (development)
+
+```bash
+git clone https://github.com/DucHuynhTrung/cliex-quick.git
+cd cliex-quick
+
+pip install -e .
+```
+
+### Using uv (optional)
+
+```bash
+uv venv
+# Windows
+.venv\Scripts\activate
+# macOS / Linux
+source .venv/bin/activate
+
+uv pip install -e .
+```
+
+After installation, the `cliex` command is available in your terminal.
+
+> **Maintainers:** see [docs/RELEASE.md](docs/RELEASE.md) for the full GitLab → GitHub mirror → PyPI + Releases workflow.
+
+## Usage
+
+### Create a new project
+
+```bash
+# Create a project in the "my-app" folder (uses the default profile)
+cliex new my-app
+
+# Create a project in the current directory
+cliex new .
+
+# No name provided → defaults to the current directory
+cliex new
+```
+
+### Choose a specific setup profile
+
+```bash
+# Use the Next.js profile
+cliex new my-app --setup nextjs-setup
+
+# Short form
+cliex new my-app -s fastapi
+
+# Use a custom YAML file directly
+cliex new my-app --setup path/to/my-setup.yaml
+```
+
+### List available profiles
+
+```bash
+cliex list
+```
+
+This displays all registered profiles, their source (package or user), and which one is the default.
+
+### Create or edit a profile
+
+```bash
+# Create a new profile (or open the file if it already exists)
+cliex registry my-custom-setup
+
+# Edit profile metadata
+cliex metadata
+```
+
+When creating a new profile, Cliex will:
+
+1. Create a `my-custom-setup.yaml` file with a sample template
+2. Automatically register the profile in `cliex-metadata.yaml`
+3. Open the file in your system's default text editor
+
+### Run without installing
+
+```bash
+python -m cliex new my-app
+python -m cliex list
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `cliex new [PROJECT_NAME]` | Create a new project using a setup profile |
+| `cliex new --setup <profile>` | Select a specific profile or YAML file |
+| `cliex list` | List all setup profiles |
+| `cliex registry <name>` | Create or edit a profile YAML file |
+| `cliex metadata` | Open `cliex-metadata.yaml` to edit metadata |
+
+## Built-in setup profiles
+
+| Profile | Description |
+|---------|-------------|
+| `nextjs-setup` *(default)* | Next.js + TypeScript + Tailwind + ESLint + shadcn/ui + Firebase + agent skills |
+| `fastapi` | FastAPI with a virtual environment |
+| `razor` | Razor project setup |
+
+Step-by-step details for each profile live in `cliex/templates/setups/`.
+
+### What does the Next.js profile do?
+
+When you run `cliex new my-app -s nextjs-setup`, Cliex will:
+
+1. Check for `node`, `npm`, `npx`, and `git`
+2. Create a Next.js project (TypeScript, Tailwind, ESLint, App Router)
+3. Install packages: Firebase, Zod, TanStack Query, Zustand, etc.
+4. Initialize shadcn/ui and add common components
+5. Install agent skills for Claude
+6. Initialize git and commit the changes
+
+## Customizing setup profiles
+
+Each profile is a YAML file with a list of `steps`. Supported step types:
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `run` | Run a shell command | `cmd: npm install` |
+| `copy` | Copy a file | `src`, `dest` |
+| `append` | Append content to a file | `file`, `content` |
+| `git` | Git operations | `add`, `commit_message`, `username`, `email` |
+
+Minimal profile example:
+
+```yaml
+steps:
+  - type: run
+    name: say-hello
+    cmd: echo "Hello from Cliex!"
+```
+
+### Where profiles are stored
+
+- **Package** (bundled with Cliex): `cliex/templates/setups/`
+- **User** (your custom profiles):
+  - Windows: `%APPDATA%\cliex\setups\`
+  - macOS / Linux: `~/.config/cliex/setups/`
+
+User-created profiles override package profiles with the same name.
+
+## Project structure
+
+```
+cliex/
+├── cliex/
+│   ├── main.py              # CLI entry point (Typer)
+│   ├── cli/
+│   │   └── new.py           # New project creation logic
+│   ├── setup/
+│   │   ├── registry.py      # Setup profile registry
+│   │   ├── loader.py        # YAML file loader
+│   │   └── executor.py      # Step executor
+│   ├── runner/
+│   │   └── runner.py        # Subprocess runner
+│   ├── checker/
+│   │   └── checker.py       # System requirement checker
+│   └── templates/
+│       └── setups/          # Default profiles + metadata
+├── pyproject.toml
+├── LICENSE
+└── README.md
+```
+
+## Troubleshooting
+
+### Missing required tools
+
+```
+Missing required commands: node, npm
+```
+
+Install the missing tools:
+
+- **Node.js / npm**: https://nodejs.org/
+- **Git**: https://git-scm.com/
+
+### Target directory already exists
+
+```
+Target folder already exists
+```
+
+Choose a different folder name or remove the existing directory before running again.
+
+### Git commit failed
+
+Configure git first:
+
+```bash
+git config --global user.name "Your Name"
+git config --global user.email "email@example.com"
+```
+
+### Profile not found
+
+Run `cliex list` to see available profiles, or create a new one with `cliex registry <name>`.
+
+## Development
+
+```bash
+# Install in editable mode
+pip install -e .
+
+# Run directly
+python -m cliex list
+```
+
+## Contributing
+
+Contributions are welcome! You can:
+
+- Report bugs or request features via [Issues](https://github.com/DucHuynhTrung/cliex-quick/issues)
+- Submit Pull Requests with new setup profiles or code improvements
+- Share your YAML profiles with the community
+
+## License
+
+This project is released under the **MIT** license — completely **free** and open source for the community.
+
+You are free to use, copy, modify, distribute, and use it commercially without permission. See [LICENSE](LICENSE) for details.
+
+## Author
+
+**DucHuynhTrung** — [huynhtrungduc.growth@gmail.com](mailto:huynhtrungduc.growth@gmail.com)
+