{"id":22165599,"url":"https://github.com/textileio/npm-textile-dep","last_synced_at":"2025-03-24T16:14:18.100Z","repository":{"id":57150990,"uuid":"240620129","full_name":"textileio/npm-textile-dep","owner":"textileio","description":null,"archived":false,"fork":false,"pushed_at":"2020-02-15T01:08:09.000Z","size":42,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-29T21:51:14.458Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textileio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2020-02-15T00:09:11.000Z","updated_at":"2020-02-15T01:07:45.000Z","dependencies_parsed_at":"2022-08-27T05:52:14.778Z","dependency_job_id":null,"html_url":"https://github.com/textileio/npm-textile-dep","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fnpm-textile-dep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fnpm-textile-dep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fnpm-textile-dep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fnpm-textile-dep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textileio","download_url":"https://codeload.github.com/textileio/npm-textile-dep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245304873,"owners_count":20593626,"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-12-02T05:15:43.065Z","updated_at":"2025-03-24T16:14:18.081Z","avatar_url":"https://github.com/textileio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Textile binary distribution for Node _(npm-textile-dep)_\n\n[![Made by Textile](https://img.shields.io/badge/made%20by-Textile-informational.svg?style=popout-square)](https://textile.io)\n[![Chat on Slack](https://img.shields.io/badge/slack-slack.textile.io-informational.svg?style=popout-square)](https://slack.textile.io)\n[![Keywords](https://img.shields.io/github/package-json/keywords/textileio/npm-textile-dep.svg?style=popout-square)](./package.json)\n\n[![GitHub package.json version](https://img.shields.io/github/package-json/v/textileio/npm-textile-dep.svg?style=popout-square)](./package.json)\n[![npm (scoped)](https://img.shields.io/npm/v/@textile/textile-dep.svg?style=popout-square)](https://www.npmjs.com/package/@textile/textile-dep)\n[![node (scoped)](https://img.shields.io/node/v/@textile/textile-dep.svg?style=popout-square)](https://www.npmjs.com/package/@textile/textile-dep)\n[![GitHub license](https://img.shields.io/github/license/textileio/npm-textile-dep.svg?style=popout-square)](./LICENSE)\n[![David](https://img.shields.io/david/dev/textileio/npm-textile-dep.svg)](https://david-dm.org/textileio/npm-textile-dep)\n[![CircleCI branch](https://img.shields.io/circleci/project/github/textileio/npm-textile-dep/master.svg?style=popout-square)](https://circleci.com/gh/textileio/npm-textile-dep)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=popout-square)](https://github.com/RichardLitt/standard-readme)\n[![docs](https://img.shields.io/badge/docs-master-success.svg?style=popout-square)](https://textileio.github.io/npm-textile-dep/)\n\n\u003e Official Textile binary distribution for Node projects\n\nJoin us on our [public Slack channel](https://slack.textile.io/) for news, discussions, and status updates.\n\n## Table of Contents\n\n- [Textile binary distribution for Node _(npm-textile-dep)_](#textile-binary-distribution-for-node-npm-textile-dep)\n  - [Table of Contents](#table-of-contents)\n  - [Background](#background)\n  - [Usage](#usage)\n    - [Overriding the textile version](#overriding-the-textile-version)\n    - [Arguments](#arguments)\n  - [Development](#development)\n  - [Maintainer](#maintainer)\n  - [Contributing](#contributing)\n  - [License](#license)\n  - [About](#about)\n\n## Background\n\n[Textile](https://www.textile.io) provides encrypted, recoverable, schema-based, and cross-application data storage built on [IPFS](https://github.com/ipfs) and [libp2p](https://github.com/libp2p). We like to think of it as a decentralized data wallet with built-in protocols for sharing and recovery, or more simply, **an open and programmable iCloud**.\n\n## Usage\n\nThis module downloads `textile` binaries from https://github.com/textileio/textile/releases into your project.\n\nBy default it will download the textile version that matches the npm version of this module. So depending on `@textile/npm-textile-dep@0.6.3` will install `textile v0.6.3` for your current system architecture, in to your project at `node_modules/@textile/textile-dep/binary/textile{.exe}`.\n\nFor a more 'standard' approach to installing `textile` in JS projects, see [`@textile/textile`](https://github.com/textileio/npm-textile).\n\n### Overriding the textile version\n\nYou can override the version of `textile` that gets downloaded by adding by adding a `textile.version` field to your `package.json`\n\n```json\n\"textile\": {\n  \"version\": \"v0.6.3\"\n},\n```\n\n### Arguments\n\nWhen used via `node dist/bin.js`, you can specify the target platform, version and architecture via environment variables: `TARGET_OS`, `TARGET_VERSION` and `TARGET_ARCH`.\n\nWe fetch the versions dynamically from [GitHub](https://github.com/textileio/textile/releases) where the OSes and architectures are listed as Assets. You can also fetch specific versions via command line arguments in the order of:\n\n```\nnode dist/bin.js \u003cversion\u003e \u003cplatform\u003e \u003carchitecture\u003e \u003cinstall directory\u003e\n```\nFor example:\n```\nnode dist/bin.js v0.6.3 linux amd64 ./textile\n```\n\n## Development\n\n**Note**: The binary gets put in the `binary` folder inside the module folder, so don't commit this!\n\n```sh\n# Run all the unit tests\nnpm run test\n\n# Lint everything\n# NOTE: Linting uses `prettier` to auto-fix styling issues when possible\nnpm run lint\n```\n\nYou can also compile the Typescript yourself with:\n\n```sh\nnpm run build\n```\n\nIf you want to push out a _new_ release, simply run `npm version {path|minor|major}` to run the CI-based release process, `npm` will automatically bump the version, and the CI will fetch the relevant `textile` version for testing etc.\n\n## Maintainer\n\n[Carson Farmer](https://github.com/carsonfarmer)\n\n## Contributing\n\nThis library is a work in progress. As such, there's a few things you can do right now to help out:\n\n  * Ask questions! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also [get in touch](https://slack.textile.io) on Slack.\n  * Log bugs, [file issues](https://github.com/textileio/npm-textile-dep/issues), submit pull requests!\n  * **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.\n  * Take a look at [textile](https://github.com/textileio/textile) (which is where the binary is built). Contributions here that would be most helpful are **top-level comments** about how it should look based on our understanding. Again, the more eyes the better.\n  * **Add tests**. There can never be enough tests.\n  * **Contribute to the [Textile docs](https://github.com/textileio/docs)** with any additions or questions you have about Textile and its various implementations. A good example would be asking, \"What is an Textile daemon\". If you don't know a term, odds are someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make Textile even better.\n\n Before you get started, be sure to read our [contributors guide](./CONTRIBUTING.md) and our [contributor covenant code of conduct](./CODE_OF_CONDUCT.md).\n\n## License\n\n[MIT](./LICENSE)\n\n## About\n\nThis package was heavily inspired (it started as a direct fork) by the [`npm-go-ipfs-dep`](https://github.com/ipfs/npm-go-ipfs-dep) library. Big thanks to all the contributors to that original package! See `package.json`, `LICENSE`, and `CHANGELOG.md` in that project for details and contributions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fnpm-textile-dep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextileio%2Fnpm-textile-dep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fnpm-textile-dep/lists"}