modsmith-cli 0.1.1__tar.gz

modsmith_cli-0.1.1/.gitattributes

@@ -0,0 +1,4 @@
+* text=auto eol=lf
+*.jar binary
+*.zip binary
+*.mrpack binary

modsmith_cli-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  lint:
+    name: Lint and type check
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - name: Check the lockfile
+        run: uv lock --check
+      - run: uv sync --locked
+      - name: Run pre-commit hooks
+        run: uv run --no-sync pre-commit run --all-files --show-diff-on-failure
+      - name: Type check
+        run: uv run --no-sync pyright
+
+  test:
+    name: Test (${{ matrix.os }}, Python ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: ubuntu-latest, python: "3.12" }
+          - { os: ubuntu-latest, python: "3.14" }
+          - { os: windows-latest, python: "3.12" }
+          - { os: macos-latest, python: "3.14" }
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv sync --locked --no-default-groups --group test
+      - name: Run tests
+        run: uv run --no-sync pytest --cov
+
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - run: uv build
+      - name: Check package metadata
+        run: uvx twine check --strict dist/*
+      - name: Run the built command with the locked dependencies
+        run: |
+          uv sync --locked --no-default-groups --no-install-project
+          uv pip install --no-deps dist/*.whl
+          uv run --no-sync modsmith --version
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  docs:
+    name: Build the documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - run: uv sync --locked --no-default-groups --group docs
+      - name: Build the site
+        run: uv run --no-sync sphinx-build -W -n -b dirhtml docs docs/_build/html

modsmith_cli-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build the site
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - run: uv sync --locked --no-default-groups --group docs
+      - name: Build the site
+        run: uv run --no-sync sphinx-build -W -n -b dirhtml docs docs/_build/html
+      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: docs/_build/html
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1

modsmith_cli-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,88 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  check-version:
+    name: Check the tag
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - name: Compare the tag with the project version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: test "v$(uv version --short)" = "$TAG"
+      - name: Make sure the library comes from PyPI
+        run: |
+          if grep -qE '^modsmith *= *[{]' pyproject.toml; then
+            echo "Remove the modsmith source and relock: the library must come from PyPI." >&2
+            exit 1
+          fi
+      - name: Read the release notes from the changelog
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          awk -v heading="## [${TAG#v}]" '
+            index($0, heading) == 1 { found = 1; next }
+            found && /^## \[/ { exit }
+            found
+          ' CHANGELOG.md > notes.md
+          grep -q '[^[:space:]]' notes.md
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: release-notes
+          path: notes.md
+          if-no-files-found: error
+
+  ci:
+    name: CI
+    needs: check-version
+    uses: ./.github/workflows/ci.yml
+
+  pypi:
+    name: Publish to PyPI
+    needs: ci
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/modsmith-cli/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+
+  github-release:
+    name: Create the GitHub release
+    needs: pypi
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: release-notes
+      - name: Create the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          TAG: ${{ github.ref_name }}
+        run: gh release create "$TAG" dist/* --verify-tag --notes-file notes.md

modsmith_cli-0.1.1/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+wheels/
+
+# Environments
+.venv/
+.env
+
+# Tool caches
+.cache/
+.coverage
+.coverage.*
+.pyright/
+.pytest_cache/
+.ruff_cache/
+htmlcov/
+
+# Editors and systems
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db
+
+# Local game files and logs
+*.log
+.minecraft/
+docs/_build/
+docs/reference/commands/
+docs/reference/settings.md

modsmith_cli-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: uv run --no-sync ruff check --fix --force-exclude
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: uv run --no-sync ruff format --force-exclude
+        language: system
+        types_or: [python, pyi]

modsmith_cli-0.1.1/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2026-11-04
+
+### Added
+
+- Modsmith is on PyPI as `modsmith-cli`: `uv tool install modsmith-cli`.
+- A guide at [modsmithmc.org/modsmith-cli](https://modsmithmc.org/modsmith-cli/),
+  with a page for every command and setting.
+
+### Changed
+
+- The project moved to [ModsmithMC/modsmith-cli](https://github.com/ModsmithMC/modsmith-cli).
+- The package is now called `modsmith-cli`; the command is still `modsmith`.
+  If you installed 0.1.0 from its wheel, remove it first with
+  `uv tool uninstall modsmith-app` (or `pipx uninstall modsmith-app`). Your
+  instances and settings stay where they are.
+- The Python package is `modsmith_cli`, so `python -m modsmith_cli` runs it.
+
+## [0.1.0] - 2026-11-03
+
+The first release of the `modsmith` command.
+
+### Added
+
+- `list`, `search` and `config`.
+- Settings in `config.toml`, overridden by environment variables and command
+  line options. `MODSMITH_HOME` keeps everything in one folder.
+- `install` installs a modpack, from a file, Modrinth or CurseForge, as a new
+  instance with its own installation in the official launcher. It shows what it
+  will change and asks first, lets you choose optional files, and takes files
+  you downloaded by hand with `--from`.
+- `create` starts an empty instance, with the recommended version of a mod
+  loader unless you name one.
+- `show` lists what an instance holds and where each file came from. `add`
+  adds mods, resource packs and shaders with what they need, and `remove`
+  takes them away with the dependencies nothing else needs. `enable`,
+  `disable`, `pin`, `unpin` and `adopt` manage what is there.
+- `update` updates an instance's pack, keeping the optional files you chose,
+  and the projects you added, showing what changed in each release. A pack
+  installed from a file updates with `--file`.
+- `import` turns an installation you made in the official launcher into an
+  instance, reading its Minecraft and loader versions and recognising its mods.
+- `move` renames an instance or moves its folder, and `delete` deletes it after
+  you type its name. Both keep the launcher installation in step.
+- `info` shows a project's details, newest releases and changelog, and
+  `loaders` lists a mod loader's versions.
+- `search --sort` orders results by relevance, downloads, popularity, newest or
+  last update.
+- `--color` and `NO_COLOR` control colour. Help shows examples.
+- Errors name every file that failed to download, and where to get files that
+  must be downloaded by hand.

modsmith_cli-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing
+
+## Setup
+
+You need [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync
+```
+
+```bash
+uv run pre-commit install
+```
+
+Until the next library release, the app follows the library's development
+branch through `[tool.uv.sources]` in `pyproject.toml`. To work on both at once,
+install your library checkout into this environment:
+
+```bash
+uv pip install -e ../CurseCraft
+```
+
+`uv sync` puts the pinned version back.
+
+## Code layout
+
+| Folder | Holds |
+| :--- | :--- |
+| `modsmith_cli/core` | Settings, paths, instance records and install planning. It never prints or asks, so the desktop app can use it too. |
+| `modsmith_cli/commands` | One module per group of commands, built with Typer. |
+| `modsmith_cli` | `app.py` puts the commands together; `ui.py`, `context.py`, `errors.py` and `target.py` hold what they share, printed with Rich. |
+
+The app uses only the library's public API.
+
+## Checks
+
+```bash
+uv run ruff check .
+```
+
+```bash
+uv run pyright
+```
+
+```bash
+uv run pytest --cov
+```
+
+```bash
+uv run sphinx-build -W -n -b dirhtml docs docs/_build/html
+```
+
+The documentation in `docs/` is published at
+<https://modsmithmc.org/modsmith-cli/> from `main`. Its command and
+settings reference is generated from the code on every build, so a new option
+only needs good help text.
+
+Tests do not use mocks. Platforms are real `Platform` subclasses that serve a
+catalogue from memory (`tests/lib/catalog.py`), and settings are isolated
+through environment variables.
+
+## Branches
+
+`main` holds released work and new versions are developed on `develop`. Build
+each feature on its own branch cut from `develop`, and merge it back through a
+pull request.
+
+## Releasing
+
+Releases are published on GitHub, built from a tag.
+
+1. Make sure the `modsmith` version the app needs is on PyPI. If
+   `[tool.uv.sources]` names `modsmith`, remove that line and run `uv lock`, so
+   the app is built and tested against the published library.
+2. Set `version` in `pyproject.toml` and move the `Unreleased` notes in
+   `CHANGELOG.md` under the new version.
+3. Merge `develop` into `main`.
+4. Push a tag such as `v0.1.0`. The tag must match the project version, and the
+   release notes come from that version's section of `CHANGELOG.md`.

modsmith_cli-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MeNeither
+
+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.