Skip to content

Commit

Permalink
Updates to the developer CLI docs (#413)
Browse files Browse the repository at this point in the history
* Updates to the developer CLI docs

* Removal of pages no longer needed and removal of content related to Archway CLI v1

* Update the developer cli URL
  • Loading branch information
emperorjm authored Nov 1, 2023
1 parent 59f6a96 commit 66b08b3
Show file tree
Hide file tree
Showing 16 changed files with 63 additions and 697 deletions.
13 changes: 1 addition & 12 deletions content/2.developers/1.getting-started/1.install.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ npm install -g @archwayhq/cli
::

::alert{variant="info"}
Since the release of [Archway CLI v2 (alpha)](/developers/developer-tools/developer-cli/developer-cli-v2), archwayd is no longer a dependency for the Developer CLI.
Since the release of [Archway CLI v2](/developers/developer-tools/developer-cli), **archwayd** is no longer a dependency for the Developer CLI.
#title
Info
::
Expand All @@ -110,17 +110,6 @@ Info

**archwayd** is an implementation of a Cosmos zone with **wasm** smart contracts enabled, and which adds new modules for developer rewards and for executing **wasm**.

**archwayd** is a dependency for deploying and managing smart contracts on Archway **only if** using the [Archway CLI v1](/developers/developer-tools/developer-cli/developer-cli-v1).


::alert{variant="info"}
Docker support for using archwayd in [Archway CLI v1](/developers/developer-tools/developer-cli/developer-cli-v1) has been removed wiith Archway CLI v1.6.0
#title
Info
::



To build **archwayd**, you can download the <a href="https://github.com/archway-network/archway/releases" target="_blank" >latest release</a>, as building **archwayd** from source is not recommended.


Expand Down
2 changes: 1 addition & 1 deletion content/2.developers/1.getting-started/3.setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parentSectionPath: /developers

A new Archway project is a Rust project that will compile to **wasm** using the **archwayd** binary, which is an implementation of a cosmos zone with **wasm** smart contracts enabled.

Let's set up a new project, using the [Developer CLI](/developers/developer-tools/developer-cli/developer-cli),
Let's set up a new project, using the [Developer CLI](/developers/developer-tools/developer-cli),

## Creating an account

Expand Down
10 changes: 2 additions & 8 deletions content/2.developers/2.developer-tools/1.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,14 @@ parentSectionPath: /developers

## Archway Developer CLI

[Archway's Developer CLI](/developers/developer-tools/developer-cli/developer-cli) is the recommended tool to build, deploy, configure, instantiate, query, and interact with smart contracts. You can find the Archway Developer CLI's github repository <a href="https://github.com/archway-network/archway-cli" target="_blank" >here</a>.
[Archway's Developer CLI](/developers/developer-tools/developer-cli) is the recommended tool to build, deploy, configure, instantiate, query, and interact with smart contracts. You can find the Archway Developer CLI's github repository <a href="https://github.com/archway-network/archway-cli" target="_blank" >here</a>.

There are three core goals of the CLI:

- Speed up development
- Deploy, connect and interact with contracts on Archway
- Encourage security and best practices for developers


We recommend testing the [Archway CLI v2 (alpha)](/developers/developer-tools/developer-cli/developer-cli-v2) and submit any feedback in the <a href="https://github.com/archway-network/archway-cli/discussions/210" target="_blank" >Github Discussion</a>.


Go to the [Developer CLI page](/developers/developer-tools/developer-cli/developer-cli) to find more details regarding the different CLI versions.

## arch3.js

[arch3.js](/developers/developer-tools/arch3js/introduction) is a JavaScript library for interacting with the Archway Protocol. `arch3.js` eliminates the need for working with multiple <a href="https://github.com/cosmos/cosmjs" target="_blank" >CosmJS</a> clients by extending their functionalities while also complementing it with Archway's unique reward system. The Github's repository of **arch3.js** can be found <a href="https://github.com/archway-network/arch3.js" target="_blank" >here</a>.
Expand All @@ -33,7 +27,7 @@ Go to the [Developer CLI page](/developers/developer-tools/developer-cli/develop
The **archwayd** binary is the core implementation of the Archway protocol, and you can find its github repository <a href="https://github.com/archway-network/archway" target="_blank" >here<a>. It leverages the <a href="https://github.com/cosmos/cosmos-sdk" target="_blank" >Cosmos SDK</a> and <a href="https://github.com/CosmWasm/cosmwasm" target="_blank" >CosmWasm</a> to reward validators and creators for their contributions to the network. The command-line interface runs a full-node of Archway and provides utilities for chain genesis, account management (keys), validators, nodes, queries and transactions.

::alert{variant="info"}
Since the release of [Archway CLI v2 (alpha)](/developers/developer-tools/developer-cli/developer-cli-v2), archwayd is no longer a dependency for the Developer CLI.
Since the release of [Archway CLI v2](/developers/developer-tools/developer-cli), **archwayd** is no longer a dependency for the Developer CLI.
#title
Info
::
Expand Down
47 changes: 47 additions & 0 deletions content/2.developers/2.developer-tools/2.developer-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
objectID: developers_developer-tools_developer-cli
title: Developer CLI
description: An overview of Archway Developer CLI commands, options and usage
parentSection: Developers
parentSectionPath: /developers
---

# Developer CLI

The Developer CLI is the recommended tool to build, deploy, configure, instantiate, query, and interact with smart contracts on the Archway blockchain.

We've introduced version 2 of the CLI, which now boasts a stable release and offers numerous enhancements over its predecessor:
- We've removed **archwayd** as a dependency, facilitating a more straightforward installation and flow. This change also boosts speed and efficiency.
- Commands have been restructured, and new sub-commands have been introduced.
- We've added commands to query and withdraw rewards, ensuring a seamless experience when managing rewards.


## Dependencies

Make sure you've installed and configured all dependencies. For the full
installation and setup instructions, [visit the docs](https://docs.archway.io/developers/getting-started/install).

- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm "Install Node.js and NPM")
- [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html "Install Cargo")
- [cargo-generate](https://crates.io/crates/cargo-generate "Install Cargo Generate")
- [docker](https://docs.docker.com/get-docker "Install Docker")

If you are on a Linux machine with a distribution different from Ubuntu, you may need to install the [GNOME Keyring](https://wiki.archlinux.org/title/GNOME/Keyring), or any other keyring compatible with the [Secret service API](https://www.gnu.org/software/emacs/manual/html_node/auth/Secret-Service-API.html).


## Installing CLI

To install the Developer CLI, run the following command:

::highlight-card

```bash
npm i -g @archwayhq/cli
```

::

## Commands

For a detailed overview of the various commands, refer to the README file in the [Archway CLI repo](https://github.com/archway-network/cli#commands).

This file was deleted.

Loading

0 comments on commit 66b08b3

Please sign in to comment.