epiq 0.4.4 → 0.4.6

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "epiq",
3
- "version": "0.4.4",
3
+ "version": "0.4.6",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "description": "EPIQ - CLI based issue tracker",
@@ -29,11 +29,12 @@
29
29
  },
30
30
  "scripts": {
31
31
  "build": "tsc --noEmit",
32
- "build:npm": "rm -rf ./dist && esbuild source/Index.tsx --bundle --packages=external --platform=node --format=esm --target=node18 --minify --outfile=dist/index.js --banner:js='#!/usr/bin/env node' && esbuild source/mcp/server.ts --bundle --packages=external --platform=node --format=esm --target=node18 --minify --outfile=dist/mcp.js --banner:js='#!/usr/bin/env node'",
33
- "build:sea:bundle": "rm -rf ./dist && esbuild source/Index.tsx --bundle --platform=node --format=cjs --target=node18 --minify --outfile=dist/sea.cjs",
32
+ "build:npm": "node scripts/write-version.mjs && rm -rf ./dist && esbuild source/Index.tsx --bundle --packages=external --platform=node --format=esm --target=node18 --minify --outfile=dist/index.js --banner:js='#!/usr/bin/env node' && esbuild source/mcp/server.ts --bundle --packages=external --platform=node --format=esm --target=node18 --minify --outfile=dist/mcp.js --banner:js='#!/usr/bin/env node'",
33
+ "build:sea:bundle": "node scripts/write-version.mjs && rm -rf ./dist && esbuild source/Index.tsx --bundle --platform=node --format=cjs --target=node18 --minify --outfile=dist/sea.cjs",
34
34
  "build:sea": "node --build-sea sea-config.json",
35
35
  "build:publish": "pnpm build:npm",
36
36
  "build:binary": "pnpm build:sea:bundle && pnpm build:sea",
37
+ "watch:npm": "node scripts/write-version.mjs && rm -rf ./dist && node scripts/watch-npm.mjs",
37
38
  "dev": "IS_LOCAL=true tsc --watch --noEmit",
38
39
  "dev:start": "IS_LOCAL=true tsx source/Index.tsx",
39
40
  "start": "IS_LOCAL=true tsx source/Index.tsx",
package/readme.md CHANGED
@@ -111,11 +111,28 @@ epiq
111
111
 
112
112
  If it is your first run, this opens the interactive setup wizard that sets you up in about 30 seconds.
113
113
 
114
- From here, you can start running commands or use keyboard shortcuts to navigate.
114
+ This creates settings in `~/.epiq-global/**`.
115
115
 
116
- This creates settings in `~/.epiq-global/**` and initializes synchronization for your repository. A local `.epiq` folder will also be created in your repository.
116
+ If the current folder is not yet an Epiq project, you will see an initialization screen.
117
117
 
118
- > Epiq will execute git commands on your behalf in order to sync your work with a dedicated state branch remotely.
118
+ Initialization will:
119
+
120
+ Create a project anchor:
121
+
122
+ ```
123
+ .epiq/project.json
124
+ ```
125
+
126
+ Create local state directories:
127
+
128
+ ```
129
+ .epiq/events/
130
+ .epiq/logs/
131
+ ```
132
+
133
+ Update your `.gitignore` to ignore local-only directories (`.epiq/events/`, `.epiq/logs/`)
134
+
135
+ > When synced, Epiq will execute git commands on your behalf, targeting a dedicated state branch
119
136
 
120
137
  ## Usage Guide
121
138
 
@@ -166,9 +183,7 @@ Clear all filters with `:filter clear`
166
183
  Epiq uses Git in the background to synchronize state between clients. No manual git commands are required to make it work. Running `:sync` pulls and pushes changes between your local state and the remote state.
167
184
 
168
185
  - Your issue data is stored in a dedicated branch managed automatically by epiq
169
- - A local `.epiq/` folder is created in your project as a local cache
170
-
171
- The `.epiq/` folder is non-authoritative and used for caching and local tracking. Epiq automatically ensures it is gitignored on every sync.
186
+ - A `.epiq/` folder is created in your project, containing both shared project metadata and local state.
172
187
 
173
188
  ## Conflict Avoidance & Data Integrity
174
189