@zinn-dev/cli 0.3.0 → 0.5.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2026 Zinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -13,23 +13,28 @@ Set `ZINN_DIR` to use another Zinn directory and keep using the same value for c
 
 ## Start a project
 
-Create a project with a name and a short key that begins with a letter and then uses only letters and numbers:
+Create a project with a key or optionally provide a name:
 
 ```sh
-zinn project create "Website refresh" SITE
+zinn project create MDR --name "Macrodata Refinement"
 ```
 
-Project keys are stored in uppercase. Each project starts with _Backlog_, _TODO_, _In Progress_, _Review_, and _Done_ columns. List projects or inspect a project's columns with:
+Project keys are stored in **uppercase**. You can create a project without a project name, like `zinn project create MDR`, which will just default to having the key as the project name too.
+Intetionally empty or whitespace project names are rejected.
+
+Each project starts with _Backlog_, _TODO_, _In Progress_, _Review_, and _Done_ columns.
+
+You can list projects or inspect a project's columns with:
 
 ```sh
 zinn project list
-zinn project column list SITE
+zinn project column list MDR
 ```
 
 Rename a project:
 
 ```sh
-zinn project edit SITE --name "Website redesign"
+zinn project edit MDR --name "Macrodata Refinement (Morning Shift)"
 ```
 
 The `--name` flag is required. Names must contain printable text on a single line.
@@ -39,26 +44,26 @@ Use `--name="--example"` when a value begins with a dash.
 Add another column at the end of the board:
 
 ```sh
-zinn project column create SITE "Waiting"
+zinn project column create MDR "Boardlog"
 ```
 
-`zinn project delete SITE` permanently deletes the project and all of its columns and tasks. The command does not ask for confirmation.
+`zinn project delete MDR` asks for confirmation, then permanently deletes the project and all of its columns and tasks.
 
 ## Create and read tasks
 
 Create a task with a title and an optional description. New tasks enter the project's first column:
 
 ```sh
-zinn task create SITE "Rewrite the home page"
-zinn task create SITE "Check the mobile layout" "Test the navigation at narrow widths"
+zinn task create MDR "Refine 75% of the numbers"
+zinn task create MDR "Review the employee handbook" "Prepare for a 75% Dance Experience"
 ```
 
-Tasks are created with keys such as `SITE-1`. List active tasks, optionally limited to one project, or view one task:
+Tasks are created with keys such as `MDR-1`. List active tasks, optionally limited to one project, or view one task:
 
 ```sh
 zinn task list
-zinn task list SITE
-zinn task view SITE-1
+zinn task list MDR
+zinn task view MDR-1
 ```
 
 When a project key is supplied, the list follows the project's column order and the task order within each column.
@@ -68,12 +73,12 @@ When a project key is supplied, the list follows the project's column order and
 Edit a task's title, description, or both:
 
 ```sh
-zinn task edit SITE-1 --title "Rewrite the landing page"
-zinn task edit SITE-1 --description "Include the new product screenshots"
-zinn task edit SITE-1 --title "Rewrite the landing page" --description ""
+zinn task edit MDR-1 --title "Meet the quarterly refinement quota"
+zinn task edit MDR-1 --description "Complete refinement before the waffle party"
+zinn task edit MDR-1 --title "Meet the quarterly refinement quota" --description ""
 ```
 
-Omitted fields stay unchanged. An empty description is stored as an empty string.
+Only the explicitly specified fields are modified and the rest are untouched. An empty string can be given for the description and is considered valid.
 
 At least one flag is required and task titles cannot be blank. Archived tasks can be edited without unarchiving them. Supplying unchanged values does not change the modification timestamp.
 Use `--title="--example"` when a value begins with a dash.
@@ -83,7 +88,7 @@ Use `--title="--example"` when a value begins with a dash.
 Move a task to another column in its project:
 
 ```sh
-zinn task move SITE-1 "In Progress"
+zinn task move MDR-1 "In Progress"
 ```
 
 A moved task appears at the bottom of its destination column. Moving it to its current column does nothing. Archived tasks must be unarchived before they can be moved.
@@ -91,13 +96,13 @@ A moved task appears at the bottom of its destination column. Moving it to its c
 Change a task's position within its current column:
 
 ```sh
-zinn task order SITE-2 top
-zinn task order SITE-2 up
-zinn task order SITE-2 down
-zinn task order SITE-2 bottom
-zinn task move SITE-2 "In Progress"
-zinn task order SITE-2 before SITE-1
-zinn task order SITE-2 after SITE-1
+zinn task order MDR-2 top
+zinn task order MDR-2 up
+zinn task order MDR-2 down
+zinn task order MDR-2 bottom
+zinn task move MDR-2 "In Progress"
+zinn task order MDR-2 before MDR-1
+zinn task order MDR-2 after MDR-1
 ```
 
 The task being reordered and the target of `before` or `after` must be active tasks in the same column.
@@ -107,9 +112,9 @@ The task being reordered and the target of `before` or `after` must be active ta
 Active tasks are shown by default. Archive a task to hide it from active lists, then list archived tasks or all tasks:
 
 ```sh
-zinn task archive SITE-1
-zinn task list SITE --archived
-zinn task list SITE --all
+zinn task archive MDR-1
+zinn task list MDR --archived
+zinn task list MDR --all
 ```
 
 `--archived` and `--all` cannot be used together. In an `--all` listing, Zinn adds an Active or Archived status column.
@@ -117,10 +122,10 @@ zinn task list SITE --all
 Unarchiving puts a task at the bottom of its previous column:
 
 ```sh
-zinn task unarchive SITE-1
+zinn task unarchive MDR-1
 ```
 
-Delete a task permanently with `zinn task delete SITE-1`. Unlike project deletion, task deletion asks for confirmation.
+Delete a task permanently with `zinn task delete MDR-1`. It asks for confirmation before performing the action.
 
 ## Help
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-dev/cli",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "A kanban workflow in the terminal.",
   "license": "MIT",
   "bugs": {
@@ -13,7 +13,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yethranayeh/zinn.git"
+    "url": "git+https://github.com/yethranayeh/zinn.git",
+    "directory": "packages/cli"
   },
   "keywords": [
     "kanban",
@@ -32,7 +33,8 @@
   },
   "files": [
     "index.ts",
-    "src"
+    "src",
+    "LICENSE"
   ],
   "type": "module",
   "bin": {
@@ -42,7 +44,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@zinn-dev/core": "0.3.0",
+    "@zinn-dev/core": "0.5.0",
     "@zinn-dev/tui": "0.0.1"
   }
 }

package/src/routes/project-router.ts

@@ -58,27 +58,53 @@ Example: zinn project edit MDR --name "Macrodata Refinement"`,
 
   create: {
     run: (args: Array<string>) => {
-      const projectName = args[0];
-      // TODO: maybe auto generate project key from name instead of forcing explicit input (however, very open to collision)
-      const projectKey = args[1];
+      const { values, positionals, tokens } = parseArgs({
+        args,
+        options: { name: { type: "string" } },
+        allowPositionals: true,
+        strict: true,
+        tokens: true,
+      });
+
+      const projectKey = positionals[0];
+
+      if (projectKey == null) {
+        quit("Project key must be specified");
+      }
+
+      if (positionals.length > 1) {
+        quit("Only one project key can be specified");
+      }
 
-      if (projectName == null || projectKey == null) {
-        quit("Both the project name and the project key must be defined");
+      const parsedArgs = new Set<string>();
+      for (const token of tokens) {
+        if (token.kind !== "option") {
+          continue;
+        }
+
+        if (parsedArgs.has(token.name)) {
+          quit(`The "--${token.name}" flag can only be specified once`);
+        }
+
+        parsedArgs.add(token.name);
       }
 
       try {
-        const createdProject = project.create({ key: projectKey, name: projectName });
+        const createdProject = project.create({ key: projectKey, name: values.name });
         console.info(`${createdProject.key} | ${createdProject.name}`);
       } catch (err: any) {
         quit(err?.message ?? "Something went wrong");
       }
     },
-    help: `Usage: zinn project create <name> <project-key>
+    help: `Usage: zinn project create <project-key> [--name <text>]
 
-Create a project with the default Backlog, TODO, In Progress, Review, and Done columns.
+Create a project with the default columns.
 Project keys are stored in uppercase.
 
-Example: zinn project create "Website refresh" SITE`,
+An omitted name defaults to the uppercase project key.
+Names cannot be blank.
+
+Example: zinn project create MDR --name "Macrodata Refinement"`,
   },
   list: {
     run: () => {
@@ -109,18 +135,31 @@ Example: zinn project list`,
       }
 
       try {
-        // TODO: add y/n confirmation
-        const deletedProject = project.delete(projectKey);
-        console.info(`Deleted ${deletedProject.key} | ${deletedProject.name}`);
+        const projectMatch = project.getByKey(projectKey);
+
+        if (projectMatch == null) {
+          throw new Error(`Project with key "${projectKey}" does not exist!`);
+        }
+
+        const canDelete = confirm(
+          `Are you sure you want to delete ${projectMatch.key} and all of its columns and tasks?`,
+        );
+
+        if (canDelete) {
+          const deletedProject = project.delete(projectKey);
+          console.info(`Deleted ${deletedProject.key} | ${deletedProject.name}`);
+        } else {
+          console.info(`Deletion cancelled for ${projectMatch.key} | ${projectMatch.name}`);
+        }
       } catch (err: any) {
         quit(err?.message ?? "Something went wrong");
       }
     },
     help: `Usage: zinn project delete <project-key>
 
-Permanently delete a project and all of its columns and tasks without confirmation.
+Permanently delete a project and all of its columns and tasks after confirmation.
 
-Example: zinn project delete SITE`,
+Example: zinn project delete MDR`,
   },
   column: {
     create: {
@@ -145,7 +184,7 @@ Example: zinn project delete SITE`,
 
 Add a column at the end of a project's board.
 
-Example: zinn project column create SITE "Waiting for review"`,
+Example: zinn project column create MDR "Boardlog"`,
     },
     list: {
       run: (args: Array<string>) => {
@@ -162,7 +201,7 @@ Example: zinn project column create SITE "Waiting for review"`,
 
 List a project's columns in board order.
 
-Example: zinn project column list SITE`,
+Example: zinn project column list MDR`,
     },
   },
 } satisfies RouteDef;

package/src/routes/task-router.ts

@@ -70,7 +70,7 @@ Titles cannot be blank.
 Archived tasks can be edited. Unchanged values leave the task unchanged.
 Use --title="--example" for text beginning with a dash.
 
-Example: zinn task edit SITE-1 --title "Rewrite the landing page"`,
+Example: zinn task edit MDR-1 --title "Meet the quarterly refinement quota"`,
   },
   create: {
     run: (args: Array<string>) => {
@@ -111,7 +111,7 @@ Example: zinn task edit SITE-1 --title "Rewrite the landing page"`,
 
 Create a task in the project's first column.
 
-Example: zinn task create SITE "Rewrite the home page" "Update the product copy"`,
+Example: zinn task create MDR "Refine the numbers" "Sort the numbers and meet the quarterly quota"`,
   },
   list: {
     run: (args) => {
@@ -177,7 +177,7 @@ Example: zinn task create SITE "Rewrite the home page" "Update the product copy"
 List active tasks by default.
 Use --archived to list archived tasks or --all to list both.
 
-Example: zinn task list SITE --all`,
+Example: zinn task list MDR --all`,
   },
   view: {
     run: (args) => {
@@ -194,7 +194,7 @@ Example: zinn task list SITE --all`,
 
 Show a task with its current column and description.
 
-Example: zinn task view SITE-1`,
+Example: zinn task view MDR-1`,
   },
   move: {
     run: (args) => {
@@ -220,7 +220,7 @@ matching placement at the bottom of a visual kanban column.
 Giving a task's current column as the target will not do anything.
 Archived tasks must be unarchived before they can be moved.
 
-Example: zinn task move SITE-1 "In Progress"`,
+Example: zinn task move MDR-1 "In Progress"`,
   },
   order: {
     run: (args) => {
@@ -272,7 +272,7 @@ Change a task's position within its current column.
 Use top or bottom for either end, up or down for one position,
 or before or after to place it relative to another task.
 
-Example: zinn task order SITE-2 before SITE-1`,
+Example: zinn task order MDR-2 before MDR-1`,
   },
   delete: {
     run: (args: Array<string>) => {
@@ -300,7 +300,7 @@ Example: zinn task order SITE-2 before SITE-1`,
 
 Permanently delete a task after confirmation.
 
-Example: zinn task delete SITE-1`,
+Example: zinn task delete MDR-1`,
   },
   archive: {
     run: (args: Array<string>) => {
@@ -317,7 +317,7 @@ Example: zinn task delete SITE-1`,
 
 Archive a task so it no longer appears in active task lists.
 
-Example: zinn task archive SITE-1`,
+Example: zinn task archive MDR-1`,
   },
   unarchive: {
     run: (args: Array<string>) => {
@@ -334,6 +334,6 @@ Example: zinn task archive SITE-1`,
 
 Unarchive a task at the bottom of its previous column.
 
-Example: zinn task unarchive SITE-1`,
+Example: zinn task unarchive MDR-1`,
   },
 } satisfies RouteDef;