@hesed/psql 0.1.0

package/oclif.manifest.json

@@ -0,0 +1,521 @@
+{
+  "commands": {
+    "psql:databases": {
+      "aliases": [],
+      "args": {},
+      "description": "List all databases accessible on the PostgreSQL server",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:databases",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "databases.js"
+      ]
+    },
+    "psql:describe-table": {
+      "aliases": [],
+      "args": {
+        "table": {
+          "description": "Table name to describe",
+          "name": "table",
+          "required": true
+        }
+      },
+      "description": "Describe the structure of a PostgreSQL table",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> users",
+        "<%= config.bin %> <%= command.id %> orders --format json --profile prod"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:describe-table",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "describe-table.js"
+      ]
+    },
+    "psql:explain-query": {
+      "aliases": [],
+      "args": {
+        "query": {
+          "description": "SQL query to explain",
+          "name": "query",
+          "required": true
+        }
+      },
+      "description": "Show the execution plan for a PostgreSQL query",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM users WHERE id = 1\"",
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM orders JOIN users ON orders.user_id = users.id\" --format json"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:explain-query",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "explain-query.js"
+      ]
+    },
+    "psql:indexes": {
+      "aliases": [],
+      "args": {
+        "table": {
+          "description": "Table name to show indexes for",
+          "name": "table",
+          "required": true
+        }
+      },
+      "description": "Show indexes for a PostgreSQL table",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> users",
+        "<%= config.bin %> <%= command.id %> orders --format json --profile prod"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:indexes",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "indexes.js"
+      ]
+    },
+    "psql:query": {
+      "aliases": [],
+      "args": {
+        "query": {
+          "description": "SQL query to execute",
+          "name": "query",
+          "required": true
+        }
+      },
+      "description": "Execute a SQL query against a PostgreSQL database",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> \"SELECT * FROM users LIMIT 10\"",
+        "<%= config.bin %> <%= command.id %> \"UPDATE users SET email = 'user@email.com' WHERE id = 999\" --format json",
+        "<%= config.bin %> <%= command.id %> \"DELETE FROM sessions\" --profile prod --skip-confirmation"
+      ],
+      "flags": {
+        "format": {
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "csv",
+            "toon"
+          ],
+          "type": "option"
+        },
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "skip-confirmation": {
+          "description": "Skip confirmation prompt for destructive operations",
+          "name": "skip-confirmation",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:query",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "query.js"
+      ]
+    },
+    "psql:tables": {
+      "aliases": [],
+      "args": {},
+      "description": "List all tables in the current PostgreSQL database",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile local"
+      ],
+      "flags": {
+        "profile": {
+          "description": "Database profile name from config",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:tables",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "tables.js"
+      ]
+    },
+    "psql:auth:add": {
+      "aliases": [],
+      "args": {},
+      "description": "Add a PostgreSQL connection profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --no-ssl"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "host": {
+          "description": "PostgreSQL host",
+          "name": "host",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "password": {
+          "char": "p",
+          "description": "Password",
+          "name": "password",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "P",
+          "description": "PostgreSQL port",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "profile": {
+          "description": "Profile name",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ssl": {
+          "description": "Use SSL",
+          "name": "ssl",
+          "required": false,
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:auth:add",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "auth",
+        "add.js"
+      ]
+    },
+    "psql:auth:test": {
+      "aliases": [],
+      "args": {},
+      "description": "Test PostgreSQL database connection",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "profile": {
+          "description": "Profile name to test",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:auth:test",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "auth",
+        "test.js"
+      ]
+    },
+    "psql:auth:update": {
+      "aliases": [],
+      "args": {},
+      "description": "Update an existing PostgreSQL connection profile",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --ssl",
+        "<%= config.bin %> <%= command.id %> --profile staging"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "database": {
+          "char": "d",
+          "description": "Database name",
+          "name": "database",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "host": {
+          "description": "PostgreSQL host",
+          "name": "host",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "password": {
+          "char": "p",
+          "description": "Password",
+          "name": "password",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "char": "P",
+          "description": "PostgreSQL port",
+          "name": "port",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "profile": {
+          "description": "Profile name to update",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ssl": {
+          "description": "Use SSL",
+          "name": "ssl",
+          "required": false,
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "user": {
+          "char": "u",
+          "description": "Username",
+          "name": "user",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "psql:auth:update",
+      "pluginAlias": "@hesed/psql",
+      "pluginName": "@hesed/psql",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "psql",
+        "auth",
+        "update.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@hesed/psql",
+  "description": "CLI for PostgreSQL database interaction",
+  "version": "0.1.0",
+  "author": "Hesed",
+  "bin": {
+    "pg": "./bin/run.js"
+  },
+  "bugs": "https://github.com/hesedcasa/psql/issues",
+  "dependencies": {
+    "@inquirer/prompts": "^8.3.0",
+    "@oclif/core": "^4",
+    "@toon-format/toon": "^2.1.0",
+    "fs-extra": "^11.3.3",
+    "pg": "^8.19.0",
+    "yaml": "^2.8.1"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2",
+    "@oclif/prettier-config": "^0.2.1",
+    "@types/chai": "^5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mocha": "^10",
+    "@types/node": "^25",
+    "@types/pg": "^8.18.0",
+    "@types/sinon": "^21.0.0",
+    "c8": "^11.0.0",
+    "chai": "^6",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "esmock": "^2.7.3",
+    "mocha": "^11",
+    "oclif": "^4",
+    "prettier": "^3.8.1",
+    "shx": "^0.4.0",
+    "sinon": "^21.0.1",
+    "ts-node": "^10",
+    "ts-prune": "^0.10.3",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/hesedcasa/psql",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "pg",
+    "dirname": "psql",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-*"
+    ],
+    "topicSeparator": " ",
+    "topics": {}
+  },
+  "repository": "hesedcasa/psql",
+  "scripts": {
+    "build": "shx rm -rf dist tsconfig.tsbuildinfo && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "test:coverage": "c8 npm test",
+    "test:coverage:report": "c8 --reporter=html --reporter=text npm test",
+    "version": "oclif readme && git add README.md",
+    "find-deadcode": "ts-prune --ignore '(run|default)'",
+    "format": "eslint --cache --fix --quiet . && prettier --write --cache .",
+    "pre-commit": "npm run format && npm run find-deadcode"
+  },
+  "types": "dist/index.d.ts",
+  "c8": {
+    "include": [
+      "src/**/*.ts"
+    ],
+    "exclude": [
+      "src/**/*.d.ts",
+      "test/**/*"
+    ],
+    "reporter": [
+      "text",
+      "lcov",
+      "html"
+    ],
+    "all": true,
+    "check-coverage": true,
+    "lines": 50,
+    "functions": 50,
+    "branches": 50,
+    "statements": 50
+  }
+}