`bash curl -fsSL https://raw.githubusercontent.com/trust-ethos/ethos-cli/main/scripts/install.sh | sh `
This installs the CLI to ~/.ethos/ and automatically keeps it up to date.
$3
`bash npm install -g @trust-ethos/cli
or
bun install -g @trust-ethos/cli `
$3
`bash brew tap trust-ethos/tap brew install ethos `
$3
`bash git clone https://github.com/trust-ethos/ethos-cli.git cd ethos-cli bun install bun run build npm link `
To unlink: npm unlink -g @trust-ethos/cli
Updates
The CLI handles updates differently depending on how you installed it:
| Install Method | Update Behavior | |----------------|-----------------| | curl | Auto-updates silently in the background | | npm | Shows update notification, run npm update -g @trust-ethos/cli | | Homebrew | Shows update notification, run brew upgrade ethos |
For curl installs, updates are checked daily and applied automatically on the next CLI run.
Usage
$3
Get user profile (includes score, XP, stats)
`bash ethos user info 0xNowater # Twitter username ethos user info vitalik.eth # ENS name ethos user info 0xd8dA6BF2... # ETH address ethos user info 0xNowater --json # JSON output `
Search for users
`bash ethos user search vitalik ethos user search "crypto developer" --limit 5 ethos user search web3 --json `
$3
List XP seasons
`bash ethos xp seasons ethos xp seasons --json `
Check leaderboard rank
`bash ethos xp rank 0xNowater ethos xp rank vitalik.eth --json `
Identifier Formats
The CLI intelligently detects identifier types:
| Format | Example | Detection | |--------|---------|-----------| | Twitter username | 0xNowater | Default (plain text) | | ETH address | 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 | 0x + 40 hex chars | | ENS name | vitalik.eth | Ends with .eth | | Explicit prefix | twitter:name, address:0x..., profileId:21 | Colon-prefixed |
JSON Output
All commands support --json (or -j) flag for machine-readable output:
`bash ethos user info 0xNowater --json | jq .score ethos user search vitalik --json | jq '.values[0].username' ethos xp rank 0xNowater --json | jq .rank `
Shell Completions
Generate shell completions for your shell:
`bash
Bash
ethos autocomplete bash
Zsh
ethos autocomplete zsh
Fish
ethos autocomplete fish `
Follow the printed instructions to add completions to your shell.
`bash git clone https://github.com/trust-ethos/ethos-cli.git cd ethos-cli bun install `
$3
`bash bun run dev # Run CLI in development mode bun run build # Build TypeScript bun test # Run tests bun run test:watch # Run tests in watch mode bun run typecheck # Type check without building bun run lint # Lint code bun run readme # Generate README command reference `
* ethos auction active * ethos auction info ID * ethos auction list * [ethos autocomplete [SHELL]](#ethos-autocomplete-shell) * ethos broker info ID * ethos broker list * ethos config get * ethos config path * ethos config set VALUE * ethos find QUERY * [ethos help [COMMAND]](#ethos-help-command) * ethos listing info IDENTIFIER * ethos listing list * ethos listing voters PROJECTID * ethos market featured * ethos market holders IDENTIFIER * ethos market info IDENTIFIER * ethos market list * ethos mi IDENTIFIER * ethos ml * ethos nft list IDENTIFIER * ethos rank IDENTIFIER * ethos review info ID * ethos review list IDENTIFIER * ethos review votes ID * ethos ri ID * ethos rl IDENTIFIER * ethos score status IDENTIFIER * ethos skill install * ethos slash info ID * ethos slash list * ethos slash votes ID * ethos u IDENTIFIER * ethos ui IDENTIFIER * ethos update * ethos us IDENTIFIER * ethos user activity IDENTIFIER * ethos user info IDENTIFIER * ethos user invitations IDENTIFIER * ethos user search QUERY * ethos user summary IDENTIFIER * ethos validator info TOKENID * ethos validator list * ethos validator sales * ethos vi ID * [ethos vl [IDENTIFIER]](#ethos-vl-identifier) * ethos vouch info ID * [ethos vouch list [IDENTIFIER]](#ethos-vouch-list-identifier) * ethos vouch mutual TARGET VIEWER * ethos vouch votes ID * ethos xp rank IDENTIFIER * ethos xp seasonsethos auction active
Show the currently active auction
` USAGE $ ethos auction active [-j] [-v]
FLAGS -j, --json Output as JSON -v, --verbose Show detailed error information
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --status=
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --search= Search in title/description -t, --type=
DESCRIPTION List broker posts (jobs, services, bounties)
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --status=
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --sentiment=
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --search= Search by name/username -v, --verbose Show detailed error information --order=
[default: desc] Sort direction --sort=
[default: marketCapWei] Sort by field
DESCRIPTION List trust markets
ALIASES $ ethos ml
EXAMPLES $ ethos market list
$ ethos market list --sort priceChange24hPercent --order desc
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --search= Search by name/username -v, --verbose Show detailed error information --order=
[default: desc] Sort direction --sort=
[default: marketCapWei] Sort by field
DESCRIPTION List trust markets
ALIASES $ ethos ml
EXAMPLES $ ethos ml
$ ethos ml --sort priceChange24hPercent --order desc
ARGUMENTS IDENTIFIER Twitter username, ETH address, or ENS name
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information
DESCRIPTION List NFTs owned by a user
EXAMPLES $ ethos nft list sethgho
$ ethos nft list 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
ARGUMENTS IDENTIFIER Twitter username, ETH address, or ENS name
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --stats Show vote statistics only -v, --verbose Show detailed error information --downvotes Show only downvotes --upvotes Show only upvotes
ARGUMENTS IDENTIFIER Twitter username, ETH address, or ENS name
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information
DESCRIPTION List reviews for a user
ALIASES $ ethos rl
EXAMPLES $ ethos rl sethgho
$ ethos rl 0xNowater --limit 20
$ ethos rl vitalik.eth --json
`ethos score status IDENTIFIER
Check score calculation status for a user
` USAGE $ ethos score status IDENTIFIER [-j] [-v]
ARGUMENTS IDENTIFIER Twitter username, ETH address, or ENS name
FLAGS -j, --json Output as JSON -v, --verbose Show detailed error information
DESCRIPTION Check score calculation status for a user
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --author= Filter by slasher userkey --status=
Filter by status --subject= Filter by subject userkey
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --stats Show vote statistics only -v, --verbose Show detailed error information --downvotes Show only downvotes --upvotes Show only upvotes
FLAGS -a, --available Show only validators with remaining XP capacity -j, --json Output as JSON -l, --limit= [default: 10] Max results to display -o, --offset= Number of results to skip -v, --verbose Show detailed error information
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information
DESCRIPTION List validator NFTs for sale on OpenSea
ARGUMENTS [IDENTIFIER] Twitter username, ETH address, or ENS name (optional, filter by subject)
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --active Show only active (non-archived) vouches --author= Filter by author (Twitter username, ETH address, or ENS name)
DESCRIPTION List vouches for a user or all vouches
ALIASES $ ethos vl
EXAMPLES $ ethos vl
$ ethos vl 0xNowater
$ ethos vl --author 0xNowater
$ ethos vl --active
$ ethos vl --limit 20 --json
`ethos vouch info ID
Get details of a specific vouch
` USAGE $ ethos vouch info ID [-j] [-v]
ARGUMENTS ID Vouch ID
FLAGS -j, --json Output as JSON -v, --verbose Show detailed error information
ARGUMENTS [IDENTIFIER] Twitter username, ETH address, or ENS name (optional, filter by subject)
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -v, --verbose Show detailed error information --active Show only active (non-archived) vouches --author= Filter by author (Twitter username, ETH address, or ENS name)
DESCRIPTION List vouches for a user or all vouches
FLAGS -j, --json Output as JSON -l, --limit= [default: 10] Max results per request -o, --offset= Number of results to skip -s, --stats Show vote statistics only -v, --verbose Show detailed error information --downvotes Show only downvotes --upvotes Show only upvotes