[BotHub-CLI] CLI 도구 사용하기 01
bothub-cli는 챗봇 호스팅 서비스 BotHub.Studio의 CLI 도구입니다. BotHub.Studio를 통해 챗봇을 만드는 예제는 아래 Python으로 Telegram 챗봇 시작하기를 참고하세요.
CLI 설치
$ pip install bothub-cli또는 virtualenv 환경을 사용한다면,
$ sudo pip install bothub-clisudo를 이용해 설치할 수 있습니다.
도움말
$ bothubUsage: bothub [OPTIONS] COMMAND [ARGS]… Bothub is a command line tool that configure, init, and deploy bot codes
to BotHub.Studio serviceOptions:
-V, — version
— help Show this message and exit.Commands:
channel Setup channels of current project
clone Clone existing project
configure Setup credentials
deploy Deploy project
init Initialize project
logs Show error logs
ls List projects
nlu Manage project NLU integrations
property Manage project properties
rm Delete a project
test Run test chat session
명령어 살펴보기
최초 사용을 위해 제일 먼저 사용하게 되는 명령어는 configure입니다.
$ bothub configure
Please enter your BotHut.Studio login credentials:
username: username
password: ********
Connecting to server…
Identified. Welcome username.BotHub.Studio 에서 회원 가입 한 username 과 password를 이용해서 서버에 연결합니다. (Username은 e-mail이 아닙니다.)
계정 연결이 완료되면 프로젝트 생성을 위해 init또는 clone을 이용하게 됩니다.
init 은 CLI를 통해 프로젝트를 생성하는 방식이며, 홈페이지에서 이미 프로젝트를 생성하셨다면 clone 을 이용해서 로컬로 받아올 수 있습니다. (git clone을 생각하시면 됩니다.)
init 을 이용해서 새로운 프로젝트를 생성하는 방법입니다. 프로젝트 이름은 중복되어 사용될 수 없습니다.
$ bothub init
Initialize a new project.
Project name: project_name
Creating project…
Initialize project template.
Download project template.
Project has created.이미 생성된 프로젝트가 있다면ls 로 목록을 확인하고, clone을 이용해서 가져옵니다.
$ bothub ls
+ — — — — — — — -+
| Project |
+ — — — — — — — -+
| project_name |
+ — — — — — — — -+$ bothub clone project_name
Project name is cloned.
해당 프로젝트를 삭제하고 싶으신가요? rm 을 통해 프로젝트를 삭제할 수 있습니다.
$ bothub rm project_name
Deleted a project: project_name프로젝트를 생성하고, 확인하고, 삭제까지 해보셨다면 이제 작성한 코드를 서버로 업로드하기 위해 새로운 프로젝트를 다시 하나 만들어주세요.
처음 init 을 하시면 기본 템플릿 코드가 bot.py에 포함되어 있습니다. init 후 생성되는 파일 구조는 다음과 같습니다.
.
|-- bothub
| |--bot.py
| `__init__.py
|--.bothub-meta
| `--meta.yml
|--bothub.yml
|--requirements.txt
`--tests 기본 템플릿 코드를 그대로 서버에 업로드 한다면,
$ bothub deploy
Make dist package.
Upload code.
Restarting container......
Project is deployed.코드를 수정하거나 추가했다면 다시 deploy를 해주시면 됩니다.
처음 사용을 위해 꼭 필요한 clone, configure, deploy, init, ls, rm 사용법이 눈에 좀 익으셨나요?
다음에는 사용할 채널(메신저)을 등록하고 로컬에서 작성한 코드를 테스트 해보도록 하겠습니다.
BotHub SDK 및 CLI 관련 문의 사항이 있으신가요?
BotHub.Studio Community를 통해 언제든 지원 받으실 수 있습니다.
