its-magic 0.1.2-14 → 0.1.2-15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +22 -10
  2. package/bin/its-magic.js +31 -13
  3. package/installer.ps1 +28 -7
  4. package/installer.py +28 -7
  5. package/installer.sh +25 -7
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -87,18 +87,30 @@ its-magic --clean-repo --target .
87
87
 
88
88
  ### Installer options
89
89
 
90
+ **Install options**
91
+
92
+ | Flag | Description |
93
+ |------|-------------|
94
+ | `--target <path>` | Path to the repository where workflow files are installed. If omitted you are prompted interactively. |
95
+ | `--mode missing` | **Default.** Only copy files that do not exist yet. Safe for repos that already have some workflow files. |
96
+ | `--mode overwrite` | Replace every file, even if it already exists. Combine with `--backup` to keep a snapshot first. |
97
+ | `--mode interactive` | Ask per file whether to overwrite or skip. Useful when you want to cherry-pick updates. |
98
+ | `--backup` | Before overwriting, save existing files to `backups/<timestamp>/`. Ignored in `missing` mode (nothing gets replaced). |
99
+ | `--create` | Create the target directory if it does not exist. |
100
+
101
+ **Clean options**
102
+
103
+ | Flag | Description |
104
+ |------|-------------|
105
+ | `--clean-repo` | Remove all its-magic workflow artifacts from the target repo (`.cursor`, `docs/product`, `docs/engineering`, `sprints`, `handoffs`, `decisions`). Your own source code is never touched. |
106
+ | `--yes` | Skip the confirmation prompt when cleaning. |
107
+
108
+ **Info**
109
+
90
110
  | Flag | Description |
91
111
  |------|-------------|
92
- | `--target <path>` | Target repo path |
93
- | `--mode missing` | Copy only missing files |
94
- | `--mode overwrite` | Replace existing files |
95
- | `--mode interactive` | Prompt per file |
96
- | `--backup` | Save replaced files into `backups/<timestamp>/` |
97
- | `--create` | Create target directory |
98
- | `--clean-repo` | Remove installed workflow artifacts (`.cursor`, `docs/product`, `docs/engineering`, `sprints`, `handoffs`, `decisions`) |
99
- | `--yes` | Skip confirmation prompt for clean |
100
- | `--help` | Show banner + usage + repo URL + version |
101
- | `--version` | Show installed its-magic version |
112
+ | `--help`, `-h` | Show banner, version, repo URL, and full usage reference. |
113
+ | `--version`, `-v` | Print the installed its-magic version and exit. |
102
114
 
103
115
  ## How-to
104
116
 
package/bin/its-magic.js CHANGED
@@ -92,23 +92,41 @@ function printHelp() {
92
92
  console.log(`its-magic v${packageJson.version}
93
93
  Repository: ${REPO_URL}
94
94
 
95
+ Install AI dev team workflow files into any Cursor repository.
96
+
95
97
  Usage:
96
- its-magic [--target <path>] [--mode <mode>] [--backup] [--create]
97
- its-magic clean [--target <path>] [--yes]
98
+ its-magic --target <path> [--mode <mode>] [--backup] [--create]
98
99
  its-magic --clean-repo [--target <path>] [--yes]
99
100
  its-magic --help | --version
100
101
 
101
- Modes:
102
- missing | overwrite | interactive
103
-
104
- Options:
105
- --target Target repository path (default: current directory)
106
- --mode Install mode (default: missing)
107
- --backup Backup files before overwrite
108
- --create Create target directory if missing
109
- --clean-repo Remove installed its-magic workflow artifacts
110
- --yes Skip clean confirmation prompt
111
- --version Show version
102
+ Install options:
103
+ --target <path> Path to the repository where workflow files are installed.
104
+ If omitted you will be prompted interactively.
105
+ --mode <mode> How to handle files that already exist in the target:
106
+ missing Only copy files that do not exist yet (default).
107
+ Safe for repos that already have some workflow files.
108
+ overwrite Replace every file, even if it already exists.
109
+ Combine with --backup to keep a snapshot first.
110
+ interactive Ask per file whether to overwrite or skip.
111
+ --backup Before overwriting, save existing files to backups/<timestamp>/.
112
+ Ignored when mode is "missing" (nothing gets replaced).
113
+ --create Create the target directory if it does not exist.
114
+
115
+ Clean options:
116
+ --clean-repo Remove all its-magic workflow artifacts from the target repo
117
+ (.cursor, docs/product, docs/engineering, sprints, handoffs,
118
+ decisions). Your own source code is never touched.
119
+ --target <path> Repo to clean (default: current directory).
120
+ --yes Skip the confirmation prompt.
121
+
122
+ Info:
123
+ --help, -h Show this help and exit.
124
+ --version, -v Print the installed version and exit.
125
+
126
+ Examples:
127
+ its-magic --target . --mode missing Safe first-time setup
128
+ its-magic --target . --mode overwrite --backup Update all files, keep backup
129
+ its-magic --clean-repo --target . --yes Remove workflow artifacts silently
112
130
  `);
113
131
  }
114
132
 
package/installer.ps1 CHANGED
@@ -109,20 +109,41 @@ function Show-ItsMagicHelp($VersionString, $RepoUrl) {
109
109
  Write-Host "its-magic v$VersionString"
110
110
  Write-Host "Repository: $RepoUrl"
111
111
  Write-Host ""
112
+ Write-Host "Install AI dev team workflow files into any Cursor repository."
113
+ Write-Host ""
112
114
  Write-Host "Usage:"
113
- Write-Host " its-magic [install options]"
115
+ Write-Host " its-magic --target <path> [--mode <mode>] [--backup] [--create]"
114
116
  Write-Host " its-magic --clean-repo [--target <path>] [--yes]"
115
117
  Write-Host " its-magic --help | --version"
116
118
  Write-Host ""
117
119
  Write-Host "Install options:"
118
- Write-Host " --target <path> Target repository path"
119
- Write-Host " --mode <mode> missing | overwrite | interactive"
120
- Write-Host " --backup Backup files before overwrite"
121
- Write-Host " --create Create target directory if missing"
120
+ Write-Host " --target <path> Path to the repository where workflow files are installed."
121
+ Write-Host " If omitted you will be prompted interactively."
122
+ Write-Host " --mode <mode> How to handle files that already exist in the target:"
123
+ Write-Host " missing Only copy files that do not exist yet (default)."
124
+ Write-Host " Safe for repos that already have some workflow files."
125
+ Write-Host " overwrite Replace every file, even if it already exists."
126
+ Write-Host " Combine with --backup to keep a snapshot first."
127
+ Write-Host " interactive Ask per file whether to overwrite or skip."
128
+ Write-Host " --backup Before overwriting, save existing files to backups/<timestamp>/."
129
+ Write-Host " Ignored when mode is 'missing' (nothing gets replaced)."
130
+ Write-Host " --create Create the target directory if it does not exist."
122
131
  Write-Host ""
123
132
  Write-Host "Clean options:"
124
- Write-Host " --clean-repo Remove installed its-magic workflow artifacts from target"
125
- Write-Host " --yes Skip clean confirmation prompt"
133
+ Write-Host " --clean-repo Remove all its-magic workflow artifacts from the target repo"
134
+ Write-Host " (.cursor, docs/product, docs/engineering, sprints, handoffs,"
135
+ Write-Host " decisions). Your own source code is never touched."
136
+ Write-Host " --target <path> Repo to clean (default: current directory)."
137
+ Write-Host " --yes Skip the confirmation prompt."
138
+ Write-Host ""
139
+ Write-Host "Info:"
140
+ Write-Host " --help Show this help and exit."
141
+ Write-Host " --version Print the installed version and exit."
142
+ Write-Host ""
143
+ Write-Host "Examples:"
144
+ Write-Host " its-magic --target . --mode missing Safe first-time setup"
145
+ Write-Host " its-magic --target . --mode overwrite --backup Update all files, keep backup"
146
+ Write-Host " its-magic --clean-repo --target . --yes Remove workflow artifacts silently"
126
147
  Write-Host ""
127
148
  }
128
149
 
package/installer.py CHANGED
@@ -104,20 +104,41 @@ def show_help(version):
104
104
  print(f"its-magic v{version}")
105
105
  print(f"Repository: {REPO_URL}")
106
106
  print()
107
+ print("Install AI dev team workflow files into any Cursor repository.")
108
+ print()
107
109
  print("Usage:")
108
- print(" its-magic [install options]")
110
+ print(" its-magic --target <path> [--mode <mode>] [--backup] [--create]")
109
111
  print(" its-magic --clean-repo [--target <path>] [--yes]")
110
112
  print(" its-magic --help | --version")
111
113
  print()
112
114
  print("Install options:")
113
- print(" --target <path> Target repository path")
114
- print(" --mode <mode> missing | overwrite | interactive")
115
- print(" --backup Backup files before overwriting")
116
- print(" --create Create target directory if missing")
115
+ print(" --target <path> Path to the repository where workflow files are installed.")
116
+ print(" If omitted you will be prompted interactively.")
117
+ print(" --mode <mode> How to handle files that already exist in the target:")
118
+ print(" missing Only copy files that do not exist yet (default).")
119
+ print(" Safe for repos that already have some workflow files.")
120
+ print(" overwrite Replace every file, even if it already exists.")
121
+ print(" Combine with --backup to keep a snapshot first.")
122
+ print(" interactive Ask per file whether to overwrite or skip.")
123
+ print(" --backup Before overwriting, save existing files to backups/<timestamp>/.")
124
+ print(" Ignored when mode is 'missing' (nothing gets replaced).")
125
+ print(" --create Create the target directory if it does not exist.")
117
126
  print()
118
127
  print("Clean options:")
119
- print(" --clean-repo Remove installed its-magic workflow artifacts from target")
120
- print(" --yes Skip clean confirmation prompt")
128
+ print(" --clean-repo Remove all its-magic workflow artifacts from the target repo")
129
+ print(" (.cursor, docs/product, docs/engineering, sprints, handoffs,")
130
+ print(" decisions). Your own source code is never touched.")
131
+ print(" --target <path> Repo to clean (default: current directory).")
132
+ print(" --yes Skip the confirmation prompt.")
133
+ print()
134
+ print("Info:")
135
+ print(" --help, -h Show this help and exit.")
136
+ print(" --version, -v Print the installed version and exit.")
137
+ print()
138
+ print("Examples:")
139
+ print(" its-magic --target . --mode missing Safe first-time setup")
140
+ print(" its-magic --target . --mode overwrite --backup Update all files, keep backup")
141
+ print(" its-magic --clean-repo --target . --yes Remove workflow artifacts silently")
121
142
  print()
122
143
 
123
144
 
package/installer.sh CHANGED
@@ -23,18 +23,36 @@ show_help() {
23
23
  show_banner
24
24
  printf "its-magic v%s\n" "$APP_VERSION"
25
25
  printf "Repository: %s\n\n" "$REPO_URL"
26
+ printf "Install AI dev team workflow files into any Cursor repository.\n\n"
26
27
  printf "Usage:\n"
27
- printf " its-magic [install options]\n"
28
+ printf " its-magic --target <path> [--mode <mode>] [--backup] [--create]\n"
28
29
  printf " its-magic --clean-repo [--target <path>] [--yes]\n"
29
30
  printf " its-magic --help | --version\n\n"
30
31
  printf "Install options:\n"
31
- printf " --target <path> Target repository path\n"
32
- printf " --mode <mode> missing | overwrite | interactive\n"
33
- printf " --backup Backup files before overwrite\n"
34
- printf " --create Create target directory if missing\n\n"
32
+ printf " --target <path> Path to the repository where workflow files are installed.\n"
33
+ printf " If omitted you will be prompted interactively.\n"
34
+ printf " --mode <mode> How to handle files that already exist in the target:\n"
35
+ printf " missing Only copy files that do not exist yet (default).\n"
36
+ printf " Safe for repos that already have some workflow files.\n"
37
+ printf " overwrite Replace every file, even if it already exists.\n"
38
+ printf " Combine with --backup to keep a snapshot first.\n"
39
+ printf " interactive Ask per file whether to overwrite or skip.\n"
40
+ printf " --backup Before overwriting, save existing files to backups/<timestamp>/.\n"
41
+ printf " Ignored when mode is 'missing' (nothing gets replaced).\n"
42
+ printf " --create Create the target directory if it does not exist.\n\n"
35
43
  printf "Clean options:\n"
36
- printf " --clean-repo Remove installed its-magic workflow artifacts from target\n"
37
- printf " --yes Skip clean confirmation prompt\n\n"
44
+ printf " --clean-repo Remove all its-magic workflow artifacts from the target repo\n"
45
+ printf " (.cursor, docs/product, docs/engineering, sprints, handoffs,\n"
46
+ printf " decisions). Your own source code is never touched.\n"
47
+ printf " --target <path> Repo to clean (default: current directory).\n"
48
+ printf " --yes Skip the confirmation prompt.\n\n"
49
+ printf "Info:\n"
50
+ printf " --help, -h Show this help and exit.\n"
51
+ printf " --version, -v Print the installed version and exit.\n\n"
52
+ printf "Examples:\n"
53
+ printf " its-magic --target . --mode missing Safe first-time setup\n"
54
+ printf " its-magic --target . --mode overwrite --backup Update all files, keep backup\n"
55
+ printf " its-magic --clean-repo --target . --yes Remove workflow artifacts silently\n\n"
38
56
  }
39
57
 
40
58
  ensure_parent() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "its-magic",
3
- "version": "0.1.2-14",
3
+ "version": "0.1.2-15",
4
4
  "description": "its-magic - AI dev team workflow for Cursor.",
5
5
  "license": "MIT",
6
6
  "bin": {