Fix: CLI documentations was missing some features #42
Conversation
This file contains hidden or 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
This pull request updates the Aleph CLI documentation to introduce and clarify support for "credits" as a new payment method for instances, alongside existing methods. It also adds documentation for credits management commands and improves guidance for users regarding payment options and related documentation links. **Payment method updates:** * Added "credit" as a supported value for the `--payment-type` option in both `aleph instance create` and `aleph instance confidential` command documentation, clarifying that users can now pay using Aleph Cloud credits [[1]](diffhunk://#diff-76866983bf4f2551f94e6d9562d39c16ceb5f042f35d8906deb13e3959fcca34L48-R48) [[2]](diffhunk://#diff-76866983bf4f2551f94e6d9562d39c16ceb5f042f35d8906deb13e3959fcca34L443-R453) [[3]](diffhunk://#diff-3616ed056fecf9111355459a6196a45ff0309e31e799a5110fead252a61267e5R87). * Updated the payment method descriptions and notes to reference [Credits](./credits.md), providing a direct link to further information. **Credits management documentation:** * Added a new "Credits Management" section to the CLI documentation index and included a reference to the corresponding command group file. * Listed new commands under the Credits domain: `aleph credits show` and `aleph credits history`. **Usage examples:** * Provided a new example command for creating an instance using credits as the payment method.
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.
This pull request updates the CLI documentation for Aleph, focusing on improving clarity, consistency, and feature coverage for account, file, and instance management commands. The changes introduce new options, clarify argument types, and expand documentation for hardware wallet (Ledger) support, file uploads, and instance operations.
Account Management Documentation Improvements:
--key-formatoption for specifying private key encoding and improved the description for--debuginaleph account create.aleph account configoptions to include Ledger support, derivation path, non-interactive mode, and clarified option names and descriptions.aleph account listcommand and its options.File Management Documentation Updates:
aleph filecommands to support uploading directories, downloading files, and clarified command descriptions.--storage-engineand--chainoptions to file upload, pin, forget, and list commands for greater flexibility and multi-chain support [1] [2] [3] [4].Instance Management Documentation Refinements:
--hypervisortoqemuonly and clarified override behavior for--vcpus,--memory, and--rootfs-sizeinaleph instance create.VM_IDis now consistentlyTEXT) and improved domain option descriptions [1] [2] [3] [4] [5].These updates make the CLI documentation more comprehensive, user-friendly, and aligned with the latest CLI features and best practices.