{"id":18308683,"url":"https://github.com/ardriveapp/ardrive-sync","last_synced_at":"2025-07-09T01:34:35.787Z","repository":{"id":42964215,"uuid":"416995121","full_name":"ardriveapp/ardrive-sync","owner":"ardriveapp","description":"The ArDrive Sync Command Line App contains basic public and private file and folder synchronization to the Arweave decentralized network.","archived":false,"fork":false,"pushed_at":"2022-11-18T22:24:31.000Z","size":151,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"production","last_synced_at":"2025-03-21T08:11:27.143Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ardriveapp.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":"2021-10-14T05:05:10.000Z","updated_at":"2023-01-12T22:13:47.000Z","dependencies_parsed_at":"2023-01-22T00:20:12.518Z","dependency_job_id":null,"html_url":"https://github.com/ardriveapp/ardrive-sync","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardriveapp%2Fardrive-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardriveapp%2Fardrive-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardriveapp%2Fardrive-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardriveapp%2Fardrive-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ardriveapp","download_url":"https://codeload.github.com/ardriveapp/ardrive-sync/tar.gz/refs/heads/production","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247375078,"owners_count":20928944,"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":[],"created_at":"2024-11-05T16:08:53.157Z","updated_at":"2025-04-05T17:32:16.079Z","avatar_url":"https://github.com/ardriveapp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ardrive-sync\n\nThe ArDrive Sync Command Line App contains basic public and private drive synchronization via a Node.js application. \n\nIt requires you to provide a local Arweave wallet JSON.  It stores this, encrypted, in  local SQLite database that is created in the directory that you run ArDrive-Sync in, called .ardrive-sync.db.  Other file metadata and transaction information is also stored in this database.\n\nTo use the ArDrive Sync, install it with your favorite package manager, and run \"ardrive-sync\".\n\nIf you are experiencing permissions issues (Mac OSX), you may also need to place your wallet file in the same directory you are running ardrive-cli\n\n---- THIS IS CURRENTLY A BETA VERSION ----\n\n## Developer Setup\n\nFirst, clone this repository to a local directory\n\n```shell\ngit clone -b production https://github.com/ardriveapp/ardrive-sync.git ./ardrive-sync\n```\n\n### Install Yarn 2\n\nArDrive Sync uses Yarn 2, so install the latest version with the [yarn installation instructions][yarn-install]. In most cases:\n\n```shell\n# Brew:\nbrew install yarn\n\n# Or with NPM:\nnpm install -g yarn\n```\n\nWe also use husky. To enable hooks locally, you will need to run:\n\n```shell\nyarn husky install\n```\n\n### Building, Installing and Starting ArDrive Sync\n\nNow that everything is set up, to install the package simply run:\n\n```shell\nyarn\n```\n\nAnd then start the ArDrive Sync command line app:\n\n```shell\nyarn start\n```\n\n\n### Installing and Starting ArDrive Sync with NPM\n\nArDrive-Sync is also available via NPM.  It can be installed globally by running the following:\n\n```shell\nnpm install ardrive-sync -g\n```\n\nAnd then start the ArDrive Sync command line app:\n\n```shell\nardrive-sync\n```\n### Recommended Visual Studio Code extensions\n\nTo ensure your environment is compatible, we also recommend the following VSCode extensions:\n\n-   [ES-Lint][eslint-vscode]\n-   [Editor-Config][editor-config-vscode]\n-   [Prettier][prettier-vscode]\n-   [ZipFS][zipfs-vscode]\n\n[yarn-install]: https://yarnpkg.com/getting-started/install\n[editor-config-vscode]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig\n[prettier-vscode]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode\n[zipfs-vscode]: https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs\n[eslint-vscode]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint\n[sqlite-db-webviewer]: https://inloop.github.io/sqlite-viewer/\n[sqlite-db-desktopviewer]: https://sqlitebrowser.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fardriveapp%2Fardrive-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fardriveapp%2Fardrive-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fardriveapp%2Fardrive-sync/lists"}