Update readme #31
Merged
Update readme #31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
WalkthroughThe project has undergone a significant update, primarily focusing on enhancing the README.md file. The changes include an improved high-level summary, a more detailed features list, and the addition of an example output for job status. Changes
Uplevel your code reviews with CodeRabbit ProCodeRabbit ProIf you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Files selected (1)
- README.md (1)
Review comments generated (2)
- Review: 1
- LGTM: 1
Tips
Chat with 
CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
Comment on lines
+20
to
+63
|
|
||
| Run `cloudexec help` to list available subcommands or `cloudexec <subcommand> --help` for information regarding a specific subcommand: | ||
|
|
||
| ```text | ||
| $ cloudexec help | ||
| NAME: | ||
| cloudexec - easily run cloud based jobs | ||
|
|
||
| USAGE: | ||
| cloudexec [global options] command [command options] [arguments...] | ||
|
|
||
| COMMANDS: | ||
| check, c Verifies cloud authentication | ||
| configure Configure credentials | ||
| init Create a new cloudexec.toml launch configuration in the current directory | ||
| launch, l Launch a droplet and start a job | ||
| logs Stream logs from a running job | ||
| cancel Cancels any running cloudexec jobs | ||
| clean Cleans up any running cloudexec droplets and clears the spaces bucket | ||
| pull Pulls down the results of the latest successful job | ||
| status, s Get status of running jobs | ||
| state Manage state file | ||
| attach, a Attach to a running job | ||
| version, v Gets the version of the app | ||
| help, h Shows a list of commands or help for one command | ||
|
|
||
| GLOBAL OPTIONS: | ||
| --help, -h show help | ||
| ``` | ||
|
|
||
| Example job status output: | ||
|
|
||
| ```text | ||
| $ cloudexec status --all | ||
| +--------+----------------+-----------+----------------+---------+------+-------+---------------------+---------------------+--------------+-------------+------------+ | ||
| | JOB ID | JOB NAME | STATUS | DROPLET IP | MEMORY | CPUS | DISK | STARTED AT | UPDATED AT | TIME ELAPSED | HOURLY COST | TOTAL COST | | ||
| +--------+----------------+-----------+----------------+---------+------+-------+---------------------+---------------------+--------------+-------------+------------+ | ||
| | 1 | medusa fuzz | completed | 12.34.56.78 | 4096 MB | 4 | 50 GB | 2024-01-01 13:55:53 | 2024-01-02 14:05:29 | 2 days | $0.125 | $6.0100 | | ||
| +--------+----------------+-----------+----------------+---------+------+-------+---------------------+---------------------+--------------+-------------+------------+ | ||
| | 2 | experiment | failed | 12.34.56.79 | 2048 MB | 2 | 25 GB | 2024-01-01 14:04:50 | 2024-01-01 14:08:03 | 3 minutes | $0.0625 | $0.0034 | | ||
| +--------+----------------+-----------+----------------+---------+------+-------+---------------------+---------------------+--------------+-------------+------------+ | ||
| | 3 | slither-mutate | running | 12.34.56.80 | 2048 MB | 2 | 25 GB | 2024-01-02 10:04:50 | 2024-01-02 12:08:03 | 2 hours | $0.0625 | $0.125 | | ||
| +--------+----------------+-----------+----------------+---------+------+-------+---------------------+---------------------+--------------+-------------+------------+ | ||
| ``` |
There was a problem hiding this comment.
The updated README provides a comprehensive overview of the project, its features, and usage. However, it might be beneficial to include some information about error handling or what users should do when they encounter issues. This could be in the form of a 'Troubleshooting' or 'Common Issues' section.
+ ## Troubleshooting
+
+ If you encounter any issues while using CloudExec, please refer to the following common problems and their solutions. If your issue is not listed here, feel free to open an issue on our GitHub repository.
+
+ ### Issue 1
+ Description and solution
+
+ ### Issue 2
+ Description and solutionThis will help users to resolve common issues by themselves and reduce the number of support requests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the high-level project summary and list features at the beginning of the readme, plus add some example output.
Summary by CodeRabbit