Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anyflowlabs/anyflow-cli
https://github.com/anyflowlabs/anyflow-cli
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/anyflowlabs/anyflow-cli
- Owner: AnyFlowLabs
- Created: 2024-09-04T22:33:53.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-11-12T12:15:26.000Z (about 2 months ago)
- Last Synced: 2024-11-12T13:24:46.313Z (about 2 months ago)
- Language: TypeScript
- Size: 144 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AnyFlow CLI
A command-line interface (CLI) for performing operations with AnyFlow.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [First Use and Authentication](#first-use-and-authentication)
- [Commands](#commands)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## Installation
To install the `anyflow-cli` inside you project:
```bash
npm install anyflow-cli
```
## Usage
After installation, you can use the `anyflow` cli in your terminal. To see the available commands and options, run:
```bash
anyflow help
```
## First Use and Authentication
To get started with the AnyFlow CLI, you'll need to authenticate your session. Follow these steps:
1. **Initialize Your Project**: If you are starting a new project, navigate to your project directory:
```bash
mkdir my-anyflow-project
cd my-anyflow-project
```
2. **Run the Init Command**: This command will create the necessary environment variables:
```bash
anyflow init
```
3. **Run the Install Command**: This will update your `hardhat.config.js` with the necessary configuration:
```bash
anyflow install
```
4. **Authenticate**: Run the following command to authenticate your session:
```bash
anyflow auth
```
This command will prompt you for your API key and may attempt to open your browser. Enter your API key when prompted to complete the authentication process.
5. **Verify Authentication**: After successful authentication, you can verify that you are logged in by running:
```bash
anyflow check-auth
```
If you see a confirmation message, you are successfully authenticated and ready to use the CLI.
## Commands
### `anyflow `
Available commands:
- `help`: Show help information for AnyFlow CLI.
- `init`: Create the necessary environment variables.
- `install`: Update your `hardhat.config.js` with the necessary configuration.
- `auth`: Authenticate your session with AnyFlow.
- `check-auth`: Check your authentication status.
- `deploy`: Upload your artifacts to the AnyFlow platform and deploy your project.
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Make your changes and commit them (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.
## License
This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.