chore: Updated readme 22d8402a
Steve · 2025-08-16 22:09 1 file(s) · +99 −0
README.md +99 −0
6 6 

            

            
            

                7
                7
                 
                
## Installation

            

            
            

                8
                8
                 
                

            

            
            

                
                9
                +
                
Install using your package manager of choice

            

            
            

                
                10
                +
                

            

            
            

                
                11
                +
                
```bash

            

            
            

                
                12
                +
                
npm i -g @stevedylandev/atlas

            

            
            

                
                13
                +
                
```

            

            
            

                
                14
                +
                

            

            
            

                
                15
                +
                
Make sure it worked by running `atlas`

            

            
            

                
                16
                +
                

            

            
            

                
                17
                +
                
```bash

            

            
            

                
                18
                +
                
atlas

            

            
            

                
                19
                +
                
```

            

            
            

                
                20
                +
                

            

            
            

                9
                21
                 
                
## Usage

            

            
            

                10
                22
                 
                

            

            
            

                
                23
                +
                
### resolve

            

            
            

                
                24
                +
                
Resolve an ENS name to an address or vice versa

            

            
            

                
                25
                +
                

            

            
            

                
                26
                +
                
```bash

            

            
            

                
                27
                +
                
# Resolve ENS name to address

            

            
            

                
                28
                +
                
atlas resolve vitalik.eth

            

            
            

                
                29
                +
                

            

            
            

                
                30
                +
                
# Resolve address to ENS name

            

            
            

                
                31
                +
                
atlas resolve 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

            

            
            

                
                32
                +
                

            

            
            

                
                33
                +
                
# Get a specific TXT record

            

            
            

                
                34
                +
                
atlas resolve vitalik.eth --txt com.github

            

            
            

                
                35
                +
                

            

            
            

                
                36
                +
                
# Get content hash

            

            
            

                
                37
                +
                
atlas resolve vitalik.eth --contenthash

            

            
            

                
                38
                +
                

            

            
            

                
                39
                +
                
# Get address for a specific chain

            

            
            

                
                40
                +
                
atlas resolve vitalik.eth --chain ETH

            

            
            

                
                41
                +
                
```

            

            
            

                
                42
                +
                

            

            
            

                
                43
                +
                
### profile

            

            
            

                
                44
                +
                
Display a complete ENS profile with all records

            

            
            

                
                45
                +
                

            

            
            

                
                46
                +
                
```bash

            

            
            

                
                47
                +
                
# Show full profile for an ENS name or address

            

            
            

                
                48
                +
                
atlas profile vitalik.eth

            

            
            

                
                49
                +
                
atlas profile 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

            

            
            

                
                50
                +
                
```

            

            
            

                
                51
                +
                

            

            
            

                
                52
                +
                
### namehash

            

            
            

                
                53
                +
                
Generate a namehash for an ENS name

            

            
            

                
                54
                +
                

            

            
            

                
                55
                +
                
```bash

            

            
            

                
                56
                +
                
atlas namehash vitalik.eth

            

            
            

                
                57
                +
                
```

            

            
            

                
                58
                +
                

            

            
            

                
                59
                +
                
### labelhash

            

            
            

                
                60
                +
                
Generate a labelhash for an ENS name

            

            
            

                
                61
                +
                

            

            
            

                
                62
                +
                
```bash

            

            
            

                
                63
                +
                
atlas labelhash vitalik

            

            
            

                
                64
                +
                
```

            

            
            

                
                65
                +
                

            

            
            

                
                66
                +
                
### resolver

            

            
            

                
                67
                +
                
Get the current resolver address for an ENS name

            

            
            

                
                68
                +
                

            

            
            

                
                69
                +
                
```bash

            

            
            

                
                70
                +
                
atlas resolver vitalik.eth

            

            
            

                
                71
                +
                
```

            

            
            

                
                72
                +
                

            

            
            

                
                73
                +
                
### deployments

            

            
            

                
                74
                +
                
List all deployed ENS contracts

            

            
            

                
                75
                +
                

            

            
            

                
                76
                +
                
```bash

            

            
            

                
                77
                +
                
atlas deployments

            

            
            

                
                78
                +
                
```

            

            
            

                
                79
                +
                

            

            
            

                11
                80
                 
                
## Development

            

            
            

                12
                81
                 
                

            

            
            

                
                82
                +
                
Make sure [Bun](https://bun.sh) is installed

            

            
            

                
                83
                +
                

            

            
            

                
                84
                +
                
```bash

            

            
            

                
                85
                +
                
bun --version

            

            
            

                
                86
                +
                
```

            

            
            

                
                87
                +
                

            

            
            

                
                88
                +
                
Clone the repo and install dependencies

            

            
            

                
                89
                +
                

            

            
            

                
                90
                +
                
```bash

            

            
            

                
                91
                +
                
git clone https://github.com/stevedylandev/atlas

            

            
            

                
                92
                +
                
cd atlas

            

            
            

                
                93
                +
                
bun install

            

            
            

                
                94
                +
                
```

            

            
            

                
                95
                +
                

            

            
            

                
                96
                +
                
After making changes use the `dev` command to create a symlink to test it

            

            
            

                
                97
                +
                

            

            
            

                
                98
                +
                
```bash

            

            
            

                
                99
                +
                
bun dev

            

            
            

                
                100
                +
                

            

            
            

                
                101
                +
                
atlas somenewthing

            

            
            

                
                102
                +
                
```

            

            
            

                
                103
                +
                

            

            
            

                
                104
                +
                
> [!NOTE]

            

            
            

                
                105
                +
                
> If you don't see any changes, make sure you uninstall any previously installed versions. If you use Bun it should overwrite but you can always manually fix it:

            

            
            

                
                106
                +
                
```bash

            

            
            

                
                107
                +
                
which atlas | rm xargs

            

            
            

                
                108
                +
                
```

            

            
            

                
                109
                +
                

            

            
            

                13
                110
                 
                
## Feedback

            

            
            

                
                111
                +
                

            

            
            

                
                112
                +
                
If you have any issues or feature requests please feel free to [open an issue](https://github.com/stevedylandev/atlas/issues/new)!