epiq 0.2.0 → 0.2.2
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 +1 -1
- package/readme.md +41 -37
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,30 +1,38 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Epiq
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
> No external services. No context switching. Just tickets - versioned and colocated with your code.
|
|
3
|
+
**CLI-native issue tracker** — powered by Git.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
```
|
|
6
|
+
'███████╗██████╗ ██╗ ██████╗ '
|
|
7
|
+
'██╔════╝██╔══██╗██║██╔═══██╗'
|
|
8
|
+
'█████╗ ██████╔╝██║██║ ██║'
|
|
9
|
+
'██╔══╝ ██╔═══╝ ██║██║▄▄ ██║'
|
|
10
|
+
'███████╗██║ ██║╚██████╔╝'
|
|
11
|
+
'╚══════╝╚═╝ ╚═╝ ╚═══▀▀╝ '
|
|
12
|
+
🫡 Never leave your editor!
|
|
13
|
+
```
|
|
7
14
|
|
|
8
15
|
## Why epiq?
|
|
9
16
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
- **
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
17
|
+
Never leave your favorite editor!
|
|
18
|
+
|
|
19
|
+
- **Zero setup** — no dashboards, no setup overhead
|
|
20
|
+
- **Repo-native** — your issues live where your code lives
|
|
21
|
+
- **Offline-first** — works anywhere Git works
|
|
22
|
+
- **Portable** — your entire project state travels with the repo
|
|
23
|
+
- **CLI-first** — fast, scriptable, and automation-friendly
|
|
16
24
|
|
|
17
25
|
---
|
|
18
26
|
|
|
19
|
-
##
|
|
27
|
+
## Installation
|
|
20
28
|
|
|
21
|
-
Install globally
|
|
29
|
+
Install globally via npm:
|
|
22
30
|
|
|
23
31
|
```bash
|
|
24
32
|
npm install --global epiq
|
|
25
33
|
```
|
|
26
34
|
|
|
27
|
-
Verify
|
|
35
|
+
Verify:
|
|
28
36
|
|
|
29
37
|
```bash
|
|
30
38
|
epiq --version
|
|
@@ -32,23 +40,12 @@ epiq --version
|
|
|
32
40
|
|
|
33
41
|
---
|
|
34
42
|
|
|
35
|
-
##
|
|
36
|
-
|
|
37
|
-
### Initialize a project
|
|
38
|
-
|
|
39
|
-
Create a new epiq workspace inside your current directory:
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
epiq --init "Project Name"
|
|
43
|
-
```
|
|
43
|
+
## Getting Started
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
---
|
|
45
|
+
Starting the application will launch a wizard that sets you up in 20 seconds.
|
|
46
|
+
It will result in settings persisted at `~/.epicrc`
|
|
48
47
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
Run epiq inside any initialized repository:
|
|
48
|
+
In any folder, run:
|
|
52
49
|
|
|
53
50
|
```bash
|
|
54
51
|
epiq
|
|
@@ -58,17 +55,24 @@ This opens the interactive CLI workspace.
|
|
|
58
55
|
|
|
59
56
|
---
|
|
60
57
|
|
|
61
|
-
##
|
|
62
|
-
|
|
63
|
-
epiq keeps issue tracking:
|
|
58
|
+
## Philosophy
|
|
64
59
|
|
|
65
|
-
|
|
66
|
-
- Versioned with your commits
|
|
67
|
-
- Simple and transparent
|
|
68
|
-
- Independent from external platforms
|
|
60
|
+
What epiq brings:
|
|
69
61
|
|
|
70
|
-
|
|
62
|
+
- **Speed** — event sourcing to the file system keeps operations fast
|
|
63
|
+
- **Editor-level productivity** — stay in the environment you already use
|
|
64
|
+
- **Repo-native issues** — tickets live alongside your code
|
|
65
|
+
- **Built-in versioning** — Git is the backend
|
|
66
|
+
- **Seamless collaboration** — leverage Git’s distributed workflow
|
|
67
|
+
- **Fully distributed** — no central configuration or registration required
|
|
71
68
|
|
|
72
69
|
---
|
|
73
70
|
|
|
74
|
-
|
|
71
|
+
## Features
|
|
72
|
+
|
|
73
|
+
- Issue tracking — lightweight, structured tickets
|
|
74
|
+
- Event log — full history of every change
|
|
75
|
+
- Filtering — query issues by tags, assignees, and more
|
|
76
|
+
- Navigation-first UI — fast keyboard-driven workflow
|
|
77
|
+
- Markdown descriptions — shareable, human-readable boards
|
|
78
|
+
- Extensible command system — built with automation in mind
|