Skip to content

Commit 349013a

Browse files
author
Youngjin Jo
authored
Merge pull request #114 from yjinjo/master
Add installation README
2 parents d7868fe + a39028d commit 349013a

File tree

1 file changed

+101
-9
lines changed

1 file changed

+101
-9
lines changed

README.md

Lines changed: 101 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,123 @@
11
# cfctl - Command Line Interface for SpaceONE
22

3-
cfctl is a powerful command-line interface tool designed to interact with SpaceONE services. It provides a seamless way to manage and control your SpaceONE resources through the command line.
3+
**cfctl** is a powerful command-line interface tool designed to interact with SpaceONE services. It provides a seamless way to manage and control your SpaceONE resources through the command line.
44

5-
## Features
5+
# Features
66

77
- **Dynamic Service Discovery**: Automatically discovers and interacts with available SpaceONE services
88
- **Multi-Environment Support**: Manages multiple environments (user/app) with easy switching
99
- **Secure Authentication**: Supports both user and application token-based authentication
1010
- **Rich Output Formats**: Supports various output formats including table, yaml, json, and csv
11-
- **Short Names**: Configurable resource aliases for faster command execution
11+
- **Alias**: Configurable resource aliases for faster command execution
1212

13-
## Installation
13+
# 01. Installation
1414

15-
### Using Homebrew (macOS)
15+
## Using Homebrew (Recommended)
1616

1717
```bash
1818
brew tap cloudforet-io/tap
1919
brew install cfctl
2020
```
2121

22-
### Manual Installation
22+
## Manual Installation
2323

24-
Download the latest binary from [releases page](https://github.com/cloudforet-io/cfctl/releases)
24+
### macOS
2525

26-
## Quick Start
26+
**For Intel Mac**
2727

28-
1. Initialize cfctl configuration:
28+
```bash
29+
curl -LO "https://github.com/cloudforet-io/cfctl/releases/latest/download/cfctl_Darwin_x86_64.tar.gz"
30+
```
31+
32+
```
33+
tar xvf cfctl_Darwin_x86_64.tar.gz
34+
chmod +x cfctl
35+
sudo mv cfctl /usr/local/bin/
36+
```
37+
38+
**For Apple Silicon Mac**
39+
40+
```bash
41+
curl -LO "https://github.com/cloudforet-io/cfctl/releases/latest/download/cfctl_Darwin_arm64.tar.gz"
42+
```
43+
44+
```bash
45+
tar xvf cfctl_Darwin_arm64.tar.gz
46+
chmod +x cfctl
47+
sudo mv cfctl /usr/local/bin/
48+
```
49+
50+
51+
### Linux
52+
53+
**For x86_64**
54+
55+
```bash
56+
curl -LO "https://github.com/cloudforet-io/cfctl/releases/latest/download/cfctl_Linux_x86_64.tar.gz"
57+
```
58+
59+
```bash
60+
tar xvf cfctl_Linux_x86_64.tar.gz
61+
chmod +x cfctl
62+
sudo mv cfctl /usr/local/bin/
63+
```
64+
65+
**For ARM64**
66+
67+
```bash
68+
curl -LO "https://github.com/cloudforet-io/cfctl/releases/latest/download/cfctl_Linux_arm64.tar.gz"
69+
```
70+
71+
```bash
72+
tar xvf cfctl_Linux_arm64.tar.gz
73+
chmod +x cfctl
74+
sudo mv cfctl /usr/local/bin/
75+
```
76+
77+
### Docker
78+
79+
**Pull the latest image**
80+
81+
```bash
82+
docker pull cloudforet/cfctl:latest
83+
```
84+
85+
**Create an alias for easier use**
86+
87+
bash
88+
89+
```bash
90+
echo 'alias cfctl="docker run --rm -it -v $HOME/.cfctl:/root/.cfctl cloudforet/cfctl:latest"' >> ~/.bashrc
91+
source ~/.bashrc
92+
```
93+
94+
zsh
95+
96+
```bash
97+
echo 'alias cfctl="docker run --rm -it -v $HOME/.cfctl:/root/.cfctl cloudforet/cfctl:latest"' >> ~/.zshrc
98+
source ~/.zshrc
99+
```
100+
101+
fish
102+
103+
```bash
104+
echo 'alias cfctl="docker run --rm -it -v $HOME/.cfctl:/root/.cfctl cloudforet/cfctl:latest"' >> ~/.config/fish/config.fish
105+
source ~/.config/fish/config.fish
106+
```
107+
108+
### Windows
109+
1. Download the latest Windows release from our [releases page](https://github.com/cloudforet-io/cfctl/releases)
110+
2. Extract the `cfctl_Windows_x86_64.zip` file
111+
3. Add the extracted directory to your system's PATH environment variable
112+
4. Open PowerShell or Command Prompt and verify the installation:
113+
114+
```powershell
115+
cfctl version
116+
```
117+
118+
# 02. Quick Start
119+
120+
## 2.1. Initialize `cfctl` configuration
29121

30122
```bash
31123
cfctl setting init

0 commit comments

Comments
 (0)