epiq 0.0.4 → 0.0.5
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 +54 -17
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,37 +1,74 @@
|
|
|
1
1
|
# epiq
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> **The ultimate productivity tool** — a CLI-based issue tracking client powered by Git as its backend, living directly inside the repository you work in.
|
|
4
|
+
> No external services. No context switching. Just tickets, versioned and colocated with your code.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Why epiq?
|
|
9
|
+
|
|
10
|
+
- **Simplicity** — Skip the additional tooling complexity
|
|
11
|
+
- **Repo-native** — Lives inside your project directory
|
|
12
|
+
- **Offline-ready** — Works wherever Git works
|
|
13
|
+
- **Team-friendly** — Collaborate through normal Git workflows
|
|
14
|
+
- **Shareable** — ASCII board exported to `.md`, viewable in the CLI, on GitHub/GitLab, or as your project README.
|
|
15
|
+
- **CLI-first** — Fast, scriptable, and developer/agent-friendly
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 📦 Installation
|
|
20
|
+
|
|
21
|
+
Install globally using npm:
|
|
6
22
|
|
|
7
23
|
```bash
|
|
8
|
-
|
|
24
|
+
npm install --global epiq
|
|
9
25
|
```
|
|
10
26
|
|
|
11
|
-
|
|
27
|
+
Verify installation:
|
|
12
28
|
|
|
13
29
|
```bash
|
|
14
|
-
|
|
30
|
+
epiq --version
|
|
15
31
|
```
|
|
16
32
|
|
|
17
|
-
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🚀 Getting Started
|
|
36
|
+
|
|
37
|
+
### Initialize a project
|
|
38
|
+
|
|
39
|
+
Create a new epiq workspace inside your current directory:
|
|
18
40
|
|
|
19
41
|
```bash
|
|
20
|
-
|
|
42
|
+
epiq --init "Project Name"
|
|
21
43
|
```
|
|
22
44
|
|
|
23
|
-
|
|
45
|
+
This sets up epiq in your repository and prepares it for issue tracking.
|
|
24
46
|
|
|
25
|
-
|
|
26
|
-
$ epiq --help
|
|
47
|
+
---
|
|
27
48
|
|
|
28
|
-
|
|
29
|
-
$ epiq
|
|
49
|
+
### Open the workspace
|
|
30
50
|
|
|
31
|
-
|
|
32
|
-
--name Your name
|
|
51
|
+
Run epiq inside any initialized repository:
|
|
33
52
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
Hello, Jane
|
|
53
|
+
```bash
|
|
54
|
+
epiq
|
|
37
55
|
```
|
|
56
|
+
|
|
57
|
+
This opens the interactive CLI workspace.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🛠 Philosophy
|
|
62
|
+
|
|
63
|
+
epiq keeps issue tracking:
|
|
64
|
+
|
|
65
|
+
- Close to your code
|
|
66
|
+
- Versioned with your commits
|
|
67
|
+
- Simple and transparent
|
|
68
|
+
- Independent from external platforms
|
|
69
|
+
|
|
70
|
+
If you use Git, you already have everything you need.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
Built for developers who live in the terminal.
|