Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dadonasll authored May 10, 2023
1 parent 8645323 commit 479429d
Showing 1 changed file with 48 additions and 2 deletions.
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
# id-magalu-cli
Repositorio solicitado pelo Danilo DADONAS - ICORE-OPS53EA
# ID Magalu CLI
CLI para operações relacionadas aos resources do ID Magalu.

## Instalação do CLI
- Realizar download do arquivo de acordo com o sistema operacional na página [Releases](https://github.com/dadonasll/id-magalu-cli/releases);
- Renomear arquivo para `idm`;

### Linux
- Tornar o arquivo executável -> `chmod +x idm`
- (opcional) Tornar o arquivo executável de qualquer lugar movendo para a pasta bin -> `sudo mv idm /usr/bin`

### Windows
- (opcional) Tornar o arquivo executável de qualquer lugar movendo para a pasta `C:\Windows\System32`.


## Utilização
### Help
```
idm <command> -h
Ex:
idm -h
idm login -h
idm client -h
```

### Login
Para utilizar as features disponíveis é necessário primeiramente realizar o login através do comando:
```
idm login
```

### Clients
#### Listando Clients
O comando a seguir retorna a lista de clients que o usuário possui:
```
idm client list
```

#### Alterando clients
O seguinte comando altera as propriedades de um client:
```
idm client update --id xxx-xxx-x-xxx-xxxx --description "Description Updated" --redirect-uris "https://service.com"
```
Para saber a lista completa de atributos que é possível alterar basta consultar através do comando:
```
idm client update -h
```

0 comments on commit 479429d

Please sign in to comment.