{"id":13554853,"url":"https://github.com/webcerebrium/couchdocs","last_synced_at":"2026-01-12T09:32:53.662Z","repository":{"id":57209746,"uuid":"96817813","full_name":"webcerebrium/couchdocs","owner":"webcerebrium","description":"Command line tool to operate with JSON files in sync with CouchDB","archived":false,"fork":false,"pushed_at":"2025-08-07T05:51:21.000Z","size":1379,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-09T03:46:32.878Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webcerebrium.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-10T20:21:29.000Z","updated_at":"2024-03-12T12:42:05.000Z","dependencies_parsed_at":"2022-08-26T23:10:46.028Z","dependency_job_id":null,"html_url":"https://github.com/webcerebrium/couchdocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webcerebrium/couchdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webcerebrium%2Fcouchdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webcerebrium%2Fcouchdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webcerebrium%2Fcouchdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webcerebrium%2Fcouchdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webcerebrium","download_url":"https://codeload.github.com/webcerebrium/couchdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webcerebrium%2Fcouchdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-08-01T12:02:56.202Z","updated_at":"2026-01-12T09:32:53.646Z","avatar_url":"https://github.com/webcerebrium.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# couchdocs\nCommand-line tools to operate with JSON files in sync with CouchDB\n\n## Installation\n```\nnpm install -g couchdocs\n```\n\n## .couchdocs File Configuration Example\nOptional file with name `.couchdocs` contains properties of CouchDB connection which should be applied for sync of JSON files in the current folder.\n```\n[couchdb]\ndb=testdb\nurl=http://localhost:5984/\n```\nYou could also use `COUCH_URL` and `COUCH_DB` variables too for database specification. \n`url` is optional, `http://localhost:5984/` is used by default, but you typically must specify `db` parameter for simplifying operations\n\nUse `-v` to have a verbose output about what is going on.\n\n## Operations\n\n#### (c) Create CouchDB Database from all merged JSON documents in current folder\n```\ncouchdocs create\ncouchdocs create http://example.com/database.tar.gz\n```\n\n#### (r) Delete existing and re-create CouchDB database from all merged documents in current folder\n```\ncouchdocs recreate\ncouchdocs recreate http://example.com/database.tar.gz\n```\n\n#### (u) Update Database document using local json file\n```\ncouchdocs update foo.json\ncouchdocs update --id _design/backend design_backend.json\n```\n\n### (a) Partial database autoupdate\n\nRead section in couchdocs file, it can declare what exact types or what documents can be safely autoupdated.\n`[autoupdate]` section can contain types that should be auto updated.\n`[exclude]` section can contain documents that should be auto updated.\n\n```\ncouchdocs autoupdate\ncouchdocs autoupdate  http://example.com/database.tar.gz\n```\n\nTypical Example of couchdocs sections for configuring autoupdates\n```\n[autoupdate]\n_id=_design/servers _design/public _design/auth\ntype=template layout widget webapp-config\n\n[exclude]\n_id=User-Backup\n```\n\n### (s) Save database into JSON files\n\nEach document becomes a separate file\n```\ncouchdocs save\n```\n\n### (z) Create tarball from JSON files in current folders\n\n```\ncouchdocs zip\n```\n\n### (b) Back up all databases using couchbackup into current folder\n\nEach database would be saved as compressed .tar.gz file. `couchbackup` will be salled, so it should be installed for that operation\n```\ncouchdocs backup\n```\n\n## Disclaimer\n\n1. This CLI tool is designed *only for Linux/Unix* systems, so most of operations will not work on Windows if you have no Cygwin tools.\n2. Development is still in progress, please use at your own risk and feel free to leave your feedback in `Issues`.\n\n### Will be added before released\n- Improving verbosity levels\n- Support of big databases\n- More suitable error handling\n- Support for delayed publishing approach\n\n\n## You might also use\n\nOther useful CLI utilities:\n\n- https://github.com/zaach/jsonlint\n- https://github.com/glynnbird/couchbackup\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebcerebrium%2Fcouchdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebcerebrium%2Fcouchdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebcerebrium%2Fcouchdocs/lists"}