Skip to content

Commit

Permalink
fix(docs): update docs after review
Browse files Browse the repository at this point in the history
Signed-off-by: Tarek <[email protected]>
  • Loading branch information
tareknaser committed Sep 26, 2023
1 parent 985ff6f commit 1f81b7a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
21 changes: 17 additions & 4 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,12 +247,19 @@ for an example of how to use this.
Interacting with Solana running programs on-chain
_________________________________________________

The command line syntax for interacting with a program deployed on Solana is as follows:

solang solana [SUBCOMMAND] [OPTIONS]... <PROGRAM_LOCATION>

This means that the command line is ``solang solana`` followed by a subcommand
followed by any of the options described below and then the program location.
It consists of a subcommand followed by its options, both of which are described below. The last argument is the program location.

.. note::

Solang relies on the local default Solana configuration file to obtain information for transaction submissions.
For comprehensive management of this configuration file, you can refer to `Solana's CLI command documentation <https://docs.solana.com/cli/usage#solana-config>`_.

General Options (for all subcommands):
++++++++++++++++++++++++++++++++++++++

\-\-output-json
Specifies whether to export the call output in JSON format.
Expand All @@ -261,17 +268,23 @@ General Options (for all subcommands):
This displays a short description of all the options.

Subcommands:
++++++++++++

solang solana deploy [OPTIONS]... <PROGRAM_LOCATION>
Deploy Subcommand
-----------------

Deploys a program to Solana.
Allows you to deploy Solana compiled programs to Solana.

Options specific to the ``deploy`` subcommand:

\-\-verbose, -v
Specifies whether to display verbose program deployment information
(Conflicts with ``--output-json``).

.. code-block:: bash
solang solana deploy --verbose flipper.so
Running Solang using a container
________________________________

Expand Down
2 changes: 1 addition & 1 deletion src/bin/cli/solana/deploy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use solana_rpc_client_api::config::RpcSendTransactionConfig;
use solana_sdk::{commitment_config::CommitmentConfig, signer::keypair::read_keypair_file};

#[derive(Clone, Debug, clap::Args)]
#[clap(name = "deploy", about = "Deploy a program to the Solana cluster")]
#[clap(name = "deploy", about = "Deploy a program to Solana")]
pub struct SolanaDeploy {
#[clap(help = "Specifies the path to the program file to deploy (.so)")]
program_location: String,
Expand Down

0 comments on commit 1f81b7a

Please sign in to comment.