{"id":20326062,"url":"https://github.com/matteoguadrini/pscouchdb","last_synced_at":"2025-04-11T20:06:23.164Z","repository":{"id":127250301,"uuid":"119047927","full_name":"MatteoGuadrini/PSCouchDB","owner":"MatteoGuadrini","description":"Advanced CLI for CouchDB server","archived":false,"fork":false,"pushed_at":"2025-02-20T13:50:02.000Z","size":12266,"stargazers_count":39,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T20:06:21.979Z","etag":null,"topics":["cli","cloudant","cloudant-database","cloudant-nosql-database","cmdlet","couchbase","couchbase-cluster","couchbase-exporter","couchbase-server","couchdb","couchdb-adapter","couchdb-client","couchdb-database","couchdb-mango","couchdb-server","database","powershell","powershell-cmdlets","powershell-gallery","powershell-module"],"latest_commit_sha":null,"homepage":"https://matteoguadrini.github.io/PSCouchDB","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MatteoGuadrini.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-26T12:15:44.000Z","updated_at":"2025-02-20T13:48:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab9e716b-dd4c-4d57-a29c-09456b1ee807","html_url":"https://github.com/MatteoGuadrini/PSCouchDB","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatteoGuadrini%2FPSCouchDB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatteoGuadrini%2FPSCouchDB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatteoGuadrini%2FPSCouchDB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatteoGuadrini%2FPSCouchDB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MatteoGuadrini","download_url":"https://codeload.github.com/MatteoGuadrini/PSCouchDB/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248473127,"owners_count":21109628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cloudant","cloudant-database","cloudant-nosql-database","cmdlet","couchbase","couchbase-cluster","couchbase-exporter","couchbase-server","couchdb","couchdb-adapter","couchdb-client","couchdb-database","couchdb-mango","couchdb-server","database","powershell","powershell-cmdlets","powershell-gallery","powershell-module"],"created_at":"2024-11-14T19:42:47.479Z","updated_at":"2025-04-11T20:06:23.152Z","avatar_url":"https://github.com/MatteoGuadrini.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://pscouchdb.readthedocs.io/en/latest/_images/pscouchdb-logo.svg\" alt=\"PSCouchDB\" align=\"right\" width=\"150\"/\u003e **PSCouchDB**: Advanced CLI for CouchDB server\n======\n\n**Docs**: [ReadTheDocs](https://pscouchdb.readthedocs.io) \n\n## Installation and simple usage\n1. Download and install CouchDB following the [docs](http://docs.couchdb.org/en/latest/install/index.html).\n2. Download and install latest PSCouchDB module by copying it under `%Windir%\\System32\\WindowsPowerShell\\v1.0\\Modules` for all users or under `%UserProfile%\\Documents\\WindowsPowerShell\\Modules` for the current user or install through [PowershellGallery](https://www.powershellgallery.com/packages/PSCouchDB).\n\u003e [!NOTE] \n\u003e This module is not signed. Before import or execute cmdlet on this module, see [about_signing](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_signing) session. To skip this part and continue, run ```Set-ExecutionPolicy -ExecutionPolicy Unrestricted```\n\u003e [!WARNING] \n\u003e If you using CouchDB version 2, use the PSCouchDB 1.X version; if instead you are using CouchDB version 3 or 4, use the PSCouchDB version 2.X\n3. Now, configure database mode, in single node (cluster of one single node) or cluster, run this cmdlet:\n```powershell\n# Single node cluster\nEnable-CouchDBCluster -SingleNode -Authorization \"admin:password\"\n# Cluster (with three node)\nEnable-CouchDBCluster -Authorization \"admin:password\"\n```\nFor more details, see the [docs](https://pscouchdb.readthedocs.io/en/latest/config.html).\n\n4. Now, open powershell and create a first personal database:\n```powershell\nNew-CouchDBDatabase -Database test -Authorization \"admin:password\"\n```\n5. Create a sample document for `test` database:\n```powershell\n$Data = '{\n\t\"name\": \"Arthur Dent\",\n\t\"planet\": \"Heart\"\n}'\nNew-CouchDBDocument -Database test -Document \"Hitchhikers\" -Data $Data -Authorization \"admin:password\"\n```\n6. Add attachment file in our docuemnt:\n```powershell\n$rev = (Get-CouchDBDocument -Database test -Document \"Hitchhikers\")._rev\n\"Ultimate Question of Life, the Universe and Everything\" | Out-File C:\\file.txt\nAdd-CouchDBAttachment -Database test -Document \"Hitchhikers\" -revision $rev -Attachment C:\\file.txt -Authorization \"admin:password\"\n```\n7. Finally, get a document:\n```powershell\nGet-CouchDBAttachment -Database test -Document \"Hitchhikers\" -Attachment file.txt\n```\n\nThese are just some of the operations you can do with this CLI.\nPSCouchDB supports all [API](https://docs.couchdb.org/en/stable/api/index.html) of CouchDB server. If you want to find out more, follow the docs.\n\n## Test PSCouchDB\nBefore test this module, [install latest](#installation-and-simple-usage) version of *CouchDB* server and latest installation of [*Pester* module](https://pester-docs.netlify.app/docs/introduction/installation).\n\u003e [!WARNING]\n\u003e Test this module in testing enviroment ONLY.\n\n```powershell\ngit clone \"https://github.com/MatteoGuadrini/PSCouchDB.git\"\ncd \"PSCouchDB/PSCouchDB/tests\"\nforeach ($f in (Get-ChildItem $PWD)) {\n\t\u0026 pwsh $f.FullName\t\t# use powershell before 6.X\n}\n```\n\n### Complete documentation\nFor other operation, for more details and for learning all cmdlets and possibilities, see the [docs](https://pscouchdb.readthedocs.io/en/latest/).\n\n### Cmdlet help\nIf you want to have an overview of the module, do this:\n```powershell\nhelp about_pscouchdb\n```\nSearch for the cmdlets using a keyword pattern and then view the help:\n```powershell\nSearch-CouchDBHelp -Pattern Database | foreach {Get-Help $_.Name}\n```\nor see [docs](https://pscouchdb.readthedocs.io/en/latest).\nFor a little demonstration, see [here](https://asciinema.org/a/232696)\n\n## Treeware  \n\nThis package is [Treeware](https://treeware.earth). If you use it in production, \nthen we ask that you [**buy the world a tree**](https://plant.treeware.earth/matteoguadrini/PSCouchDB) to thank us for our work. \nBy contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.\n\n[![Treeware](https://img.shields.io/badge/dynamic/json?color=brightgreen\u0026label=Treeware\u0026query=%24.total\u0026url=https%3A%2F%2Fpublic.offset.earth%2Fusers%2Ftreeware%2Ftrees)](https://treeware.earth)\n\n## [Donation and Support](https://pscouchdb.readthedocs.io/en/latest/support.html).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatteoguadrini%2Fpscouchdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatteoguadrini%2Fpscouchdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatteoguadrini%2Fpscouchdb/lists"}