epiq 0.2.26 → 0.2.27

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 (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +37 -37
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "epiq",
3
- "version": "0.2.26",
3
+ "version": "0.2.27",
4
4
  "license": "UNLICENSED",
5
5
  "type": "module",
6
6
  "description": "EPIQ - CLI based issue tracker",
package/readme.md CHANGED
@@ -5,8 +5,6 @@
5
5
  **CLI-native issue tracker** — powered by Git.
6
6
  Manage all your projects directly via the command line, edit in your favorite editor.
7
7
 
8
- Epiq stores your issue tracker as event logs inside your Git repository.
9
-
10
8
  ```
11
9
  '███████╗██████╗ ██╗ ██████╗ '
12
10
  '██╔════╝██╔══██╗██║██╔═══██╗'
@@ -17,32 +15,21 @@ Epiq stores your issue tracker as event logs inside your Git repository.
17
15
  🫡 Never leave your editor!
18
16
  ```
19
17
 
18
+ ## What is epiq?
19
+
20
+ Epiq is a vim-inspired issue tracker fully integrated in the terminal that brings the tooling to the developers’ fingertips - in their comfort zone.
21
+
22
+ Epiq renders your issue board directly in the terminal using ASCII and stores its state as an event log, versioned and synchronized through Git.
23
+
20
24
  ## Features
21
25
 
22
- - Issue tracking — tickets with name, description, tags, assignees, and history log
23
- - Filtering — query issues by description, tags, assignees, and so on
26
+ - Issue tracking — track work in tickets with name, description, tags, assignees, history log, etc.
27
+ - Filtering — query issues by description, tags, assignees, etc.
24
28
  - Ergonomics — fast keyboard-driven navigation
25
29
  - Autocompletion — minimize typing, stay in flow
26
30
  - Command system — built with ergonomics and automation in mind
27
- - Traceable event log — full history of every change
28
-
29
- ### Example workflow:
30
-
31
- An issue lifecycle as epiq commands:
32
-
33
- ```
34
- 1. epiq new issue "Fix login bug"
35
- 2. epiq assign @john
36
- 3. epiq tag urgent
37
- 4. # move with keys to reflect progress
38
- 5. epiq close
39
- ```
40
-
41
- ## What is epiq?
42
-
43
- Epiq is a vim-inspired issue tracker fully integrated in the terminal that brings the tooling to the developers’ fingertips in their comfort zone.
44
-
45
- Epiq renders your issue board directly in the terminal using ASCII and stores its state on disk using an event log, versioned and synchronized in Git, resulting in a fast application that can run anywhere, anytime, by anyone with access to Git. It also works without Git for single-user setups.
31
+ - Multi-user — real-time synchronization of board
32
+ - Traceable event log — state is a full history of every change ever made
46
33
 
47
34
  ## Why epiq?
48
35
 
@@ -54,12 +41,24 @@ These design choices result in a system that is:
54
41
  - **Repo-native** — your issues live where your code lives
55
42
  - **Offline-friendly** — works anywhere, with eventual consistency as a promise
56
43
  - **Speed** — local first, and eventual consistency makes epiq edits instant
57
- - **Portable** — run on your local machine, on a dusty old Linux server or your grandma’s connected toaster
44
+ - **Portable** — run on your local machine, on a remote Linux server or your grandma’s connected toaster
58
45
  - **Command driven** — scriptable and automation-friendly, ready for the agentic era
59
46
  - **Versioned** — every change is tracked and recoverable through Git
60
47
 
61
48
  ---
62
49
 
50
+ ### Example workflow:
51
+
52
+ An issue lifecycle as epiq commands:
53
+
54
+ ```
55
+ 1. epiq new issue "Fix login bug"
56
+ 2. epiq assign @john
57
+ 3. epiq tag urgent
58
+ 4. # move with keys to reflect progress
59
+ 5. epiq close
60
+ ```
61
+
63
62
  ## Installation
64
63
 
65
64
  Install globally via npm:
@@ -78,19 +77,20 @@ epiq --version
78
77
 
79
78
  ## Getting Started
80
79
 
81
- Starting the application will launch a wizard that sets you up in 20 seconds.
82
- It will result in settings and state persisted in `~/.epiq/**`
83
-
84
80
  In any folder, run:
85
81
 
86
82
  ```bash
87
83
  epiq
88
84
  ```
89
85
 
90
- If it is your first run, this opens the interactive setup wizard.
86
+ If it is your first run, this opens the interactive setup wizard that sets you up in about 30 seconds.
91
87
 
92
88
  From here, you can start running commands or use keyboard shortcuts to navigate.
93
89
 
90
+ This creates local settings in `~/.epiq/**` and initializes synchronization for your repository. A local `.epiq` folder will also be created in your repository.
91
+
92
+ > Epiq will execute git commands on your behalf in order to sync your work with a dedicated state branch remotely.
93
+
94
94
  ## Usage Guide
95
95
 
96
96
  ### Help
@@ -107,19 +107,19 @@ From here, you can start running commands or use keyboard shortcuts to navigate.
107
107
  - If you type `:` you are put in command line mode and can now insert commands.
108
108
  - Commands are context-aware, so for instance `:close` only exists for issues.
109
109
 
110
- ### :new ...
110
+ ### Create nodes: issue | swimlane | board
111
111
 
112
112
  - Create nodes with `:new issue|swimlane|board <Name of new node>`.
113
113
 
114
114
  ### Move nodes
115
115
 
116
- - Move nodes by pressing `m`. This sets you in a move state, after which you can navigate as normal, navigate to the target location, then press m again to confirm.
116
+ - Move nodes by pressing `m`. This sets you in a move state, after which you can navigate as normal, navigate to the target location, then press m again to confirm new location.
117
117
 
118
118
  ### Filtering
119
119
 
120
- - Apply filters with the `filter` command followed by a target, and a qualifier. So in order to filter `prio` tags you can write `:filter tag prio` and hit `enter`. By running several filter commands in succession you add a combination of filters.
120
+ - Apply filters with the `filter` command followed by a target, and a qualifier. So in order to filter all issues with a `prio` tag you can write `:filter tag prio` and hit `enter`. You can build a combination of filters by running several filter commands in succession.
121
121
 
122
- Clear filters with `:filter clear`
122
+ Clear all filters with `:filter clear`
123
123
 
124
124
  ### Close issue
125
125
 
@@ -127,13 +127,13 @@ Clear filters with `:filter clear`
127
127
 
128
128
  ### Reopen
129
129
 
130
- - You can reopen a task by visiting the `Closed` board, selecting an issue and typing command `:reopen`.
130
+ - You can reopen a task by visiting the `Closed` board, selecting an issue and typing command `:reopen`. This will restore the issue to its last previous location.
131
131
 
132
132
  ---
133
133
 
134
134
  ## How epiq is synchronized
135
135
 
136
- Epiq uses Git to synchronize state between clients. Running `:sync` pulls and pushes changes between your local state and the remote.
136
+ Epiq uses Git in the background to synchronize state between clients. You do not need to do any manual git commands to make it work. Running `:sync` pulls and pushes changes between your local state and the remote.
137
137
 
138
138
  - Your issue data is stored in a dedicated branch managed automatically by epiq
139
139
  - A local `.epiq/` folder is created in your project as a cache
@@ -144,8 +144,8 @@ The `.epiq/` folder:
144
144
  - Can be committed if you want your board state versioned alongside your code
145
145
  - Is optional — epiq works whether you commit it or not
146
146
 
147
- You generally don’t need to interact with these directly.
148
-
149
- > ⓘ The system is designed to avoid merge conflicts.
147
+ > The system is designed to avoid merge conflicts.
150
148
 
151
149
  ---
150
+
151
+ 🫡 Never leave your editor!