@glamsystems/glam-cli 0.1.18 → 0.1.20

package/README.md

@@ -1,5 +1,7 @@
 # GLAM CLI
 
+![NPM Version](https://img.shields.io/npm/v/%40glamsystems%2Fglam-cli)
+
 A convenient way of interacting with the GLAM program.
 
 ## Installation
@@ -10,126 +12,6 @@ npm install -g @glamsystems/glam-cli
 
 After installation, you can use the CLI with the `glam-cli` command.
 
-## Configure
-
-The CLI expects a configuration file at `~/.config/glam/config.json`. The file should contain the following content:
-
-```json
-{
-  "cluster": "",
-  "json_rpc_url": "",
-  "tx_rpc_url": "",
-  "keypair_path": "",
-  "priority_fee": {
-    "micro_lamports": 0,
-    "level": "",
-    "helius_api_key": ""
-  },
-  "glam_state": ""
-}
-```
-
-_At minimum, you need to provide `cluster`, `json_rpc_url`, and `keypair_path`._
-
-Here's a quick explanation of each field:
-
-- `cluster`: Value must be one of `mainnet-beta`, `devnet`, or `localnet`.
-- `json_rpc_url`: The URL of your preferred Solana JSON RPC endpoint.
-- `tx_rpc_url`: Optional. If not set it defaults to `json_rpc_url`. Use this to specify a separate RPC endpoint you want to use for landing transactions.
-- `keypair_path`: Path to your keypair JSON file.
-- `priority_fee`:
-  - `micro_lamports`: Optional (defaults to 0). If provided, `level` and `helius_api_key` will be ignored.
-  - `level`: Optional (defaults to `Min`). Only applied if cluster is `mainnet-beta`. Other options are `Min`, `Medium`, `High`, `VeryHigh`, `UnsafeMax`, `Default` (more info can be found [here](https://docs.helius.dev/solana-apis/priority-fee-api)).
-  - `helius_api_key`: Optional. Only applied if cluster is `mainnet-beta`. If not provided `level` will be ignored. The API key is needed to fetch the priority fee estimate from Helius.
-- `glam_state`: Optional. If you want to set a default active GLAM state, you can do so here. Alternatively, you can use the `set` command to set the active GLAM state later on.
-
-## Commands
-
-Run `glam-cli --help` to see all available commands. Here are the main command categories:
-
-### General Commands
-
-- `glam-cli env` - Show environment setup
-- `glam-cli list` - List GLAM products the wallet has access to
-  - `-o, --owner-only` - Only list products the wallet owns
-  - `-a, --all` - List all GLAM products
-
-### Product Management
-
-- `glam-cli view [state]` - View a GLAM product by its state pubkey
-  - `-c, --compact` - Compact output
-- `glam-cli set <state>` - Set active GLAM product
-- `glam-cli create <path>` - Create a new GLAM product from a JSON file
-- `glam-cli close [state]` - Close a GLAM product
-  - `-y, --yes` - Skip confirmation prompt
-- `glam-cli update-owner <new-owner-pubkey>` - Update the owner of a GLAM product (**dangerous! may lead to loss of assets if you don't control the new owner wallet**)
-  - `-y, --yes` - Skip confirmation prompt
-- `glam-cli withdraw <asset> <amount>` - Withdraw asset (mint address) from the vault
-  - `-y, --yes` - Skip confirmation prompt
-
-### Delegate Management
-
-- `glam-cli delegate list` - List delegates and permissions
-- `glam-cli delegate set <pubkey> <permissions...>` - Set delegate permissions
-- `glam-cli delegate delete <pubkey>` - Revoke all delegate permissions for a pubkey
-
-### Mint Management
-
-- `glam-cli mint holders` - List all token holders
-- `glam-cli mint update <state> <options...>` - Update mint policies
-  - `-l, --lockup <seconds>` - Set lockup period in seconds
-  - `-f, --frozen <boolean>` - Set default account state frozen
-- `glam-cli mint create-account <owner>` - Idempotent create a token account for a user
-- `glam-cli mint freeze <accounts...>` - Freeze token accounts (space-separated pubkeys)
-- `glam-cli mint unfreeze <accounts...>` - Unfreeze token accounts (space-separated pubkeys)
-- `glam-cli mint issue <recipient> <amount>` - Mint tokens to a recipient
-- `glam-cli mint burn <from> <amount>` - Burn tokens from a user
-- `glam-cli mint transfer <from> <to> <amount>` - Force transfer tokens between accounts
-
-### Integration Management
+## Documentation
 
-- `glam-cli integration list` - List all enabled integrations
-- `glam-cli integration enable <name>` - Enable an integration
-- `glam-cli integration disable <name>` - Disable an integration
-
-### Token Operations
-
-- `glam-cli swap <from> <to> <amount>` - Swap assets held in the vault
-  - `-m, --max-accounts <num>` - Specify max accounts allowed
-  - `-s, --slippage-bps <bps>` - Specify slippage bps
-  - `-d, --only-direct-routes` - Direct routes only
-
-### Liquid Staking
-
-- `glam-cli lst stake <stakepool> <amount>` - Stake `<amount>` SOL into `<stakepool>`
-- `glam-cli lst unstake <asset> <amount>` - Unstake `<amount>` worth of `<asset>` (mint address)
-- `glam-cli lst list` - List all stake accounts
-- `glam-cli lst withdraw <accounts...>` - Withdraw staking accounts (space-separated pubkeys)
-- `glam-cli lst marinade-list` - List all Marinade tickets
-- `glam-cli lst marinade-claim <tickets...>` - Claim Marinade tickets (space-separated)
-
-### Jupiter (JUP) Staking
-
-- `glam-cli jup stake <amount>` - Stake JUP tokens
-- `glam-cli jup unstake` - Unstake all JUP tokens
-- `glam-cli jup withdraw` - Withdraw all unstaked JUP
-
-### Governance
-
-- `glam-cli vote <proposal> <side>` - Vote on a proposal
-
-## Development
-
-### Build from Source
-
-Clone https://github.com/glamsystems/glam/, enter the repo and run:
-
-```bash
-pnpm install && pnpm run cli-build
-```
-
-### Run in Development Mode
-
-```bash
-npx nx run cli:dev -- --args="command [options]"
-```
+Please visit [GLAM CLI Documentation](https://docs.glam.systems/cli/) for more information.