Skip to content
README 1.69 KiB
Newer Older
Seblu's avatar
Seblu committed
=======
Profile
=======
A profile in a set of configuration options.
cc-cli support FreeDesktop BaseDirectory specifications, see
http://standards.freedesktop.org/basedir-spec/0.6/ to store his config files.
Seblu's avatar
Seblu committed
Profiles are stored in ~/.config/cc-cli/profile. This file format is ini in which
Seblu's avatar
Seblu committed
every profile is a section.
cc-cli load at every start the cli profile. You can specify
a default profile in cli profile with option "profile".
You will find examples in examples subdirectory in git repository.

To quickly connect to mulptiple servers, you can define a profile by server.

Seblu's avatar
Seblu committed
=======
Loading
=======
Seblu's avatar
Seblu committed
Configuration is loaded in this order:
1 Check CC_DEBUG, to set early debugging mode
Seblu's avatar
Seblu committed
2 load [cli] profile from ~/.config/cc-cli/profile
3 load profile specified by option profile (arg line, env, cli profile)
4 load options from environment
5 load options from command line
Seblu's avatar
Seblu committed

===========
Environment
===========
You can set some options by environment variables.
The following variables are recognised: CC_SERVER, CC_PORT, CC_LOGIN, CC_PASS,
CC_DEBUG, CC_PROFILE.
Seblu's avatar
Seblu committed

=====
Alias
=====
CLI support aliasing. This is a very useful command substitution
Seblu's avatar
Seblu committed
Alias is stored in ~/.config/cc-cli/alias
Seblu's avatar
Seblu committed
You can use the alias command to set alias.

Setting an alias w, which list online client
alias w "list a&con!=offline&role=client"

Setting an alias vm, which list running vm (and show cpu)
alias vm "list vm&status=running$cpu"

Seblu's avatar
Seblu committed
=======
History
=======
Seblu's avatar
Seblu committed
CLI history is stored in ~/.local/share/cc-cli/history
Expoert mode history is stored in ~/.local/share/cc-cli/expert
Seblu's avatar
Seblu committed

Seblu's avatar
Seblu committed
===
TQL
===
You can look in TQL file to see the power of tql.

Seblu's avatar
Seblu committed
===========
New release
===========
Update version in cccli/__init__.py
Seblu's avatar
Seblu committed
Update version in debian/changelog