1- ## ** < Project Name > **
1+ ## ** GLI, An Experimental CLI for Outscale, written in Go **
22
33[ ![ Project Stage] ( https://docs.outscale.com/fr/userguide/_images/Project-Sandbox-yellow.svg )] ( https://docs.outscale.com/en/userguide/Open-Source-Projects.html ) [ ![ ] ( https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat&theme=default-inverted )] ( https://discord.gg/HUVtY5gT6s )
44
3232
3333## 🧭 Overview
3434
35- ** < Project Name >** is a <short description of what the project does, e.g., "CLI tool to manage...">.
36-
37- Key features:
38- - <Feature 1>
39- - <Feature 2>
40- - <Feature 3>
35+ ** CLI** is an experimental CLI for the Outscale APIs, written in Go.
4136
4237---
4338
4439## ✅ Requirements
4540
46- - <Dependency 1> (e.g., Rust, Go, Python 3.11+)
47- - <Dependency 2> (e.g., Git)
4841- Access to the OUTSCALE API (with appropriate credentials)
4942
5043---
5144
5245## ⚙ Installation
5346
54- ### Option 1: Download from Releases
55-
56- Download the latest binary from the [ Releases page] ( https://github.com/outscale/<project-name>/releases ) .
47+ Download the latest binary from the [ Releases page] ( https://github.com/outscale/gli/releases ) .
5748
58- ### Option 2: Install from source
49+ ---
5950
60- ``` bash
61- git clone https://github.com/outscale/< project-name> .git
62- cd < project-name>
63- < build or install command>
64- ````
51+ ## 🛠 Configuration
6552
66- Example (for Go projects):
6753
68- ` ` ` bash
69- go install github.com/outscale/< project-name> @latest
70- ` ` `
54+ The tool expects either environment variables or a configuration file.
7155
72- ---
56+ ### Environment variables
7357
74- # # 🛠 Configuration
58+ The tool will try to read the following environment variables:
59+ * ` OSC_ACCESS_KEY `
60+ * ` OSC_SECRET_KEY `
61+ * ` OSC_REGION `
7562
76- \< Explain where the credentials or config are stored, e.g.: >
63+ ### Profile file
7764
78- The tool expects a configuration file at ` ~/.osc/config.json` .
65+ If no environment variables are defined, the tool will read ` ~/.osc/config.json ` and look for the ` default ` profile .
7966
8067### Example
8168
@@ -89,39 +76,39 @@ The tool expects a configuration file at `~/.osc/config.json`.
8976}
9077```
9178
92- Use the ` --profile ` flag to select another profile.
79+ Use ` OSC_CONFIG_FILE ` to define an alternate config file and ` OSC_PROFILE ` an alternate profile.
9380
9481---
9582
9683## 🚀 Usage
9784
9885``` bash
99- < command> [OPTIONS]
86+ gli < command> < api call >
10087```
10188
89+ ### Commands
90+
91+ | Command | Description |
92+ | ------- | ----------- |
93+ | ` oapi ` | Call OAPI |
94+ | ` version ` | Display version |
95+
10296### Options
10397
104- | Option | Description |
105- | ------------------ | -------------------------------------- |
106- | ` -f, --flag` | What this flag does |
107- | ` -c, --count < N> ` | Run N times |
108- | ` --profile < name> ` | Use a specific profile from the config |
109- | ` -v, --version` | Print version and exit |
98+ | Option | Description |
99+ | ------------------ | ----------- |
100+ | ` -v, --verbose ` | Dump HTTP request and response |
101+ | ` -h, --help ` | Help about a command |
110102
111103---
112104
113105## 💡 Examples
114106
115- # ## Basic usage
116-
117- ` ` ` bash
118- < command>
119- ` ` `
120-
121- # ## With options
107+ ### ReadVms
122108
109+ List all VMs in the ` running ` state:
123110``` bash
124- < command > --flag value --profile test
111+ gli oapi ReadVms --Filters.VmStateNames running
125112```
126113
127114### Using ` jq ` to filter JSON output
@@ -134,9 +121,9 @@ jq '.[] | select(.ResponseStatusCode != 200)' logs.json
134121
135122## 📜 License
136123
137- ** < Project Name > ** is released under the < License Name > license.
124+ ** <GLI ** is released under the BSD 3-Clause license.
138125
139- © < Year > Outscale SAS
126+ © 2026 Outscale SAS
140127
141128See [ LICENSE] ( ./LICENSE ) for full details.
142129
@@ -147,15 +134,3 @@ See [LICENSE](./LICENSE) for full details.
147134We welcome contributions!
148135
149136Please read our [ Contributing Guidelines] ( CONTRIBUTING.md ) and [ Code of Conduct] ( CODE_OF_CONDUCT.md ) before submitting a pull request.
150-
151- ---
152-
153- # ## Notes for reuse:
154- - Replace all ` < ...> ` placeholders with your content.
155- - You can prefill the ` Project Stage` badge with values like:
156- - ` Project-Incubating-blue.svg`
157- - ` Project-Graduated-green.svg`
158- - You may include platform-specific instructions (macOS/Linux/Windows) in collapsible ` < details> ` blocks if needed.
159-
160- > Labels are centrally managed in the outscale/.github repository (labels.yml).
161- > This repo includes a workflow (.github/workflows/sync-labels.yml) that syncs labels from there.
0 commit comments