Skip to content

installation script #11

Closed
#12
Closed
installation script#11
#12

Description

@techsavvyash
techsavvyash
opened on Oct 3, 2025

By the time this plugin is approved and available for use via the community plugins way. I want you to help me write a script I can run via npx or bunx which takes the path of my vault as input and copies the main.js, style.css and manifest.json into the .obsidian/plugins/vync folder of the vault so that I have access to this plugin.

All these files can be fetched from the latest release which is present on the repository.

Ensure to update the readme with the script usage and the steps to publish that script if that is needed and github actions required to publish that script incase script publishing is required.

Ensure to give a PR for these changes.

Activity

  1. techsavvyash commented on Oct 3, 2025

    @techsavvyash
    techsavvyash
    on Oct 3, 2025
    OwnerAuthor

    @claude please pick this ticket and raise a PR.

  2. claude commented on Oct 3, 2025

    @claude
    claudeBot
    on Oct 3, 2025 – with Claude

    Claude finished @techsavvyash's task —— View job • claude/issue-11-20251003-1559 • Create PR ➔

    ✅ Issue #11: Installation Script Complete

    Summary

    Created a complete installation script solution that allows users to install the Vync plugin via npx or bunx.

    What was implemented

    • Installer Package (packages/installer/):

      • CLI tool that fetches the latest release from GitHub
      • Downloads main.js, manifest.json, and styles.css
      • Installs files to .obsidian/plugins/vync/ in the specified vault
      • Includes proper error handling and vault validation
      • Works on Unix, Linux, macOS, and Windows

    • Documentation:

      • Updated main README with installation instructions
      • Created comprehensive PUBLISHING.md guide
      • Added installer package README with usage examples

    • GitHub Actions:

      • Provided workflow template at packages/installer/publish-installer.yaml.template
      • Repository owner needs to copy this to .github/workflows/ (I don't have permission to modify workflows)

    Usage

    Once the installer is published to NPM, users can install the plugin with:

    # Using npx
npx @techsavvyash/vync-installer /path/to/vault

# Using bunx
bunx @techsavvyash/vync-installer /path/to/vault

    Next Steps

    1. Setup GitHub Actions workflow (requires repo owner):

      cp packages/installer/publish-installer.yaml.template .github/workflows/publish-installer.yaml
git add .github/workflows/publish-installer.yaml
git commit -m "chore: add installer publishing workflow"
git push

    2. Setup NPM publishing (see PUBLISHING.md):

      • Create NPM account
      • Generate automation token
      • Add NPM_TOKEN to GitHub Secrets

    3. Publish the installer:

      • Use GitHub Actions workflow or manually publish to NPM
      • Full instructions in PUBLISHING.md

    Files Changed

    • packages/installer/ - New installer package
    • README.md - Added installation instructions
    • PUBLISHING.md - Complete publishing guide
    • packages/installer/publish-installer.yaml.template - GitHub Actions workflow template

    Branch: claude/issue-11-20251003-1559
    Job Run: Link

  3. claude
    added a commit that references this issue on Oct 3, 2025

    feat: add npx/bunx installer script for plugin installation

    af91838
  4. techsavvyash
    closed this as completedin #12on Oct 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions