https://github.com/rayhanadev/crosis4furrets
An abstraction layer on top of @replit/crosis that makes Repl connection management and operations so easy, a Furret could do it! 🎉
https://github.com/rayhanadev/crosis4furrets
crosis crosis4furrets goval protobuf3 protocol replit replit-api replit-cli
Last synced: 8 months ago
JSON representation
An abstraction layer on top of @replit/crosis that makes Repl connection management and operations so easy, a Furret could do it! 🎉
- Host: GitHub
- URL: https://github.com/rayhanadev/crosis4furrets
- Owner: rayhanadev
- License: mit
- Created: 2022-06-24T19:42:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T19:35:45.000Z (about 3 years ago)
- Last Synced: 2025-02-17T14:13:22.200Z (over 1 year ago)
- Topics: crosis, crosis4furrets, goval, protobuf3, protocol, replit, replit-api, replit-cli
- Language: TypeScript
- Homepage:
- Size: 879 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Crosis4Furrets
An abstraction layer on top of [@replit/crosis](https://www.npmjs.com/package/@replit/crosis)
that makes Repl connection management and operations so easy, a Furret could do it! :tada:
> The latest version of `crosis4furrets@1.3.0-beta.*` is bleeding edge, it is recommended you
> use `crosis4furrets@1.2.x` for your projects.
## Install
```sh
# with NPM
$ npm install crosis4furrets@1.2.x
# with Yarn
$ yarn add crosis4furrets@1.2.x
```
## Usage
### Main API
```js
import { Client } from 'crosis4furrets';
const client = new Client({
token: process.env.REPLIT_TOKEN,
replId: process.env.REPLIT_REPL_ID,
});
```
which returns a [``](#client). See [DOCUMENTATION.md](./DOCUMENTATION.md) for docs on how
to use Crosis4Furrets.
## Example
```js
import { Client } from 'crosis4furrets';
const client = new Client({
token: process.env.REPLIT_TOKEN,
replId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
});
await client.connect();
console.log('Read:\n', await client.read('index.js', 'utf-8'));
```
### Access Keys
Run the following command in your Repl to get its **Repl ID**:
```bash
$ echo $REPL_ID
```
or alternatively make a [GraphQL Request](https://replit.com/graphql)
with the following query:
```graphql
query ReplID ($url: String) {
repl(url: $url) {
...on Repl { id }
}
}
```
```json
{
"url": "/@/"
}
```
To get a **Replit Token**, you can visit [this Repl](https://login-test.rayhanadev.repl.co).
## Contributing
This project is in active development and we would love some :sparkles: fabulous
:sparkles: contributions! To get started, visit our [Contributing](https://github.com/rayhanadev/crosis4furrets/blob/main/CONTRIBUTING.md)
documentation.
## Licensing
This project is licensed under the MIT License. For more information, see [LICENSE](https://github.com/rayhanadev/crosis4furrets/blob/main/LICENSE).