aboutsummaryrefslogblamecommitdiffstats
path: root/README.html
blob: a1f67cd8244a57911a82c69d6c082f6044aebc54 (plain) (tree)
1
2
3
4
5
6




                                                                   
                             



































































































































































































































                                                                            

                                      
    


                                               

     
                                      
    

                                                
    

                                             



     
                                    
    

                                                   
    




                                         







                                                                         


                                                         





                        


                                                         
      


                                                         







                                  


                                                         
                               


                                                                                 

      


      


                                                         
                               
                                                                                                                  
                                                       


                                                                                                               
                    
                                                                                    
         
                                                                                  






         


                                                         
      


                                                         



                                    



                                                                                                                                      










                                                                             




                                                  
                                                                                                                  
                                                       


                                                                                                               
                                                          
                                                                                    
         
                                                                                  





         


                                                         







                                                                               


                                                         









                                    


                                                         
















                                                     


                                                         









                                                                                

                                                                                                                     

                               

                                                                                             
                                        
                                                                                                                            
                                         
                                                                                                      

                                 
                                                                                           

                             
                                                                                            



                            
                                                                                              
                       

                                                                                                                                               














                                                                                              


                                                         


























                                                                                                      
                                                                                                                                            
 

                                                                                                                

                              
                                                                                      






                            


                                                         
      


                                                         








                               

                                                                  









                                         

                                                                                                                     





                               


                                                         




          
                                        



                           

                                                                         


                                                                           
                                                               



          


                   
                                 
                                                                         

                                                       





                               
                                                                                                                    





                                           


                                                         





                                                                             


    













                                                                         




                                                                                             



                               
                                                                                                                                        
                 
                                                                                                
                      
                                                                                                 





                        


                                                         












                                                                
                                                               





                               






                                                                                                                          


                 














                                                                                                                                                                                                                                             


      


                                                         

          






                      













                                                             

                                   
                                                 



                                                                                          
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2018-09-28 Fri 23:23 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
<meta name="generator" content="Org mode" />
<style type="text/css">
 <!--/*--><![CDATA[/*><!--*/
  .title  { text-align: center;
             margin-bottom: .2em; }
  .subtitle { text-align: center;
              font-size: medium;
              font-weight: bold;
              margin-top:0; }
  .todo   { font-family: monospace; color: red; }
  .done   { font-family: monospace; color: green; }
  .priority { font-family: monospace; color: orange; }
  .tag    { background-color: #eee; font-family: monospace;
            padding: 2px; font-size: 80%; font-weight: normal; }
  .timestamp { color: #bebebe; }
  .timestamp-kwd { color: #5f9ea0; }
  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
  .underline { text-decoration: underline; }
  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  p.verse { margin-left: 3%; }
  pre {
    border: 1px solid #ccc;
    box-shadow: 3px 3px 3px #eee;
    padding: 8pt;
    font-family: monospace;
    overflow: auto;
    margin: 1.2em;
  }
  pre.src {
    position: relative;
    overflow: visible;
    padding-top: 1.2em;
  }
  pre.src:before {
    display: none;
    position: absolute;
    background-color: white;
    top: -10px;
    right: 10px;
    padding: 3px;
    border: 1px solid black;
  }
  pre.src:hover:before { display: inline;}
  /* Languages per Org manual */
  pre.src-asymptote:before { content: 'Asymptote'; }
  pre.src-awk:before { content: 'Awk'; }
  pre.src-C:before { content: 'C'; }
  /* pre.src-C++ doesn't work in CSS */
  pre.src-clojure:before { content: 'Clojure'; }
  pre.src-css:before { content: 'CSS'; }
  pre.src-D:before { content: 'D'; }
  pre.src-ditaa:before { content: 'ditaa'; }
  pre.src-dot:before { content: 'Graphviz'; }
  pre.src-calc:before { content: 'Emacs Calc'; }
  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  pre.src-fortran:before { content: 'Fortran'; }
  pre.src-gnuplot:before { content: 'gnuplot'; }
  pre.src-haskell:before { content: 'Haskell'; }
  pre.src-hledger:before { content: 'hledger'; }
  pre.src-java:before { content: 'Java'; }
  pre.src-js:before { content: 'Javascript'; }
  pre.src-latex:before { content: 'LaTeX'; }
  pre.src-ledger:before { content: 'Ledger'; }
  pre.src-lisp:before { content: 'Lisp'; }
  pre.src-lilypond:before { content: 'Lilypond'; }
  pre.src-lua:before { content: 'Lua'; }
  pre.src-matlab:before { content: 'MATLAB'; }
  pre.src-mscgen:before { content: 'Mscgen'; }
  pre.src-ocaml:before { content: 'Objective Caml'; }
  pre.src-octave:before { content: 'Octave'; }
  pre.src-org:before { content: 'Org mode'; }
  pre.src-oz:before { content: 'OZ'; }
  pre.src-plantuml:before { content: 'Plantuml'; }
  pre.src-processing:before { content: 'Processing.js'; }
  pre.src-python:before { content: 'Python'; }
  pre.src-R:before { content: 'R'; }
  pre.src-ruby:before { content: 'Ruby'; }
  pre.src-sass:before { content: 'Sass'; }
  pre.src-scheme:before { content: 'Scheme'; }
  pre.src-screen:before { content: 'Gnu Screen'; }
  pre.src-sed:before { content: 'Sed'; }
  pre.src-sh:before { content: 'shell'; }
  pre.src-sql:before { content: 'SQL'; }
  pre.src-sqlite:before { content: 'SQLite'; }
  /* additional languages in org.el's org-babel-load-languages alist */
  pre.src-forth:before { content: 'Forth'; }
  pre.src-io:before { content: 'IO'; }
  pre.src-J:before { content: 'J'; }
  pre.src-makefile:before { content: 'Makefile'; }
  pre.src-maxima:before { content: 'Maxima'; }
  pre.src-perl:before { content: 'Perl'; }
  pre.src-picolisp:before { content: 'Pico Lisp'; }
  pre.src-scala:before { content: 'Scala'; }
  pre.src-shell:before { content: 'Shell Script'; }
  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
  /* additional language identifiers per "defun org-babel-execute"
       in ob-*.el */
  pre.src-cpp:before  { content: 'C++'; }
  pre.src-abc:before  { content: 'ABC'; }
  pre.src-coq:before  { content: 'Coq'; }
  pre.src-groovy:before  { content: 'Groovy'; }
  /* additional language identifiers from org-babel-shell-names in
     ob-shell.el: ob-shell is the only babel language using a lambda to put
     the execution function name together. */
  pre.src-bash:before  { content: 'bash'; }
  pre.src-csh:before  { content: 'csh'; }
  pre.src-ash:before  { content: 'ash'; }
  pre.src-dash:before  { content: 'dash'; }
  pre.src-ksh:before  { content: 'ksh'; }
  pre.src-mksh:before  { content: 'mksh'; }
  pre.src-posh:before  { content: 'posh'; }
  /* Additional Emacs modes also supported by the LaTeX listings package */
  pre.src-ada:before { content: 'Ada'; }
  pre.src-asm:before { content: 'Assembler'; }
  pre.src-caml:before { content: 'Caml'; }
  pre.src-delphi:before { content: 'Delphi'; }
  pre.src-html:before { content: 'HTML'; }
  pre.src-idl:before { content: 'IDL'; }
  pre.src-mercury:before { content: 'Mercury'; }
  pre.src-metapost:before { content: 'MetaPost'; }
  pre.src-modula-2:before { content: 'Modula-2'; }
  pre.src-pascal:before { content: 'Pascal'; }
  pre.src-ps:before { content: 'PostScript'; }
  pre.src-prolog:before { content: 'Prolog'; }
  pre.src-simula:before { content: 'Simula'; }
  pre.src-tcl:before { content: 'tcl'; }
  pre.src-tex:before { content: 'TeX'; }
  pre.src-plain-tex:before { content: 'Plain TeX'; }
  pre.src-verilog:before { content: 'Verilog'; }
  pre.src-vhdl:before { content: 'VHDL'; }
  pre.src-xml:before { content: 'XML'; }
  pre.src-nxml:before { content: 'XML'; }
  /* add a generic configuration mode; LaTeX export needs an additional
     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
  pre.src-conf:before { content: 'Configuration File'; }

  table { border-collapse:collapse; }
  caption.t-above { caption-side: top; }
  caption.t-bottom { caption-side: bottom; }
  td, th { vertical-align:top;  }
  th.org-right  { text-align: center;  }
  th.org-left   { text-align: center;   }
  th.org-center { text-align: center; }
  td.org-right  { text-align: right;  }
  td.org-left   { text-align: left;   }
  td.org-center { text-align: center; }
  dt { font-weight: bold; }
  .footpara { display: inline; }
  .footdef  { margin-bottom: 1em; }
  .figure { padding: 1em; }
  .figure p { text-align: center; }
  .inlinetask {
    padding: 10px;
    border: 2px solid gray;
    margin: 10px;
    background: #ffffcc;
  }
  #org-div-home-and-up
   { text-align: right; font-size: 70%; white-space: nowrap; }
  textarea { overflow-x: auto; }
  .linenr { font-size: smaller }
  .code-highlighted { background-color: #ffff00; }
  .org-info-js_info-navigation { border-style: none; }
  #org-info-js_console-label
    { font-size: 10px; font-weight: bold; white-space: nowrap; }
  .org-info-js_search-highlight
    { background-color: #ffff00; color: #000000; font-weight: bold; }
  .org-svg { width: 90%; }
  /*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart  The following is the entire license notice for the
JavaScript code in this tag.

Copyright (C) 2012-2018 Free Software Foundation, Inc.

The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version.  The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.

As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.


@licend  The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
 function CodeHighlightOn(elem, id)
 {
   var target = document.getElementById(id);
   if(null != target) {
     elem.cacheClassElem = elem.className;
     elem.cacheClassTarget = target.className;
     target.className = "code-highlighted";
     elem.className   = "code-highlighted";
   }
 }
 function CodeHighlightOff(elem, id)
 {
   var target = document.getElementById(id);
   if(elem.cacheClassElem)
     elem.className = elem.cacheClassElem;
   if(elem.cacheClassTarget)
     target.className = elem.cacheClassTarget;
 }
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org1d54245">ck</a></li>
<li><a href="#org0f23886">build it</a>
<ul>
<li><a href="#org633fb0e">requirements</a></li>
<li><a href="#org132a993">compiler</a></li>
<li><a href="#orgad56911">make</a></li>
</ul>
</li>
<li><a href="#orgb2415b8">for devs</a>
<ul>
<li><a href="#orgfebd554">CMake options</a></li>
<li><a href="#orgba141a7">tests</a>
<ul>
<li><a href="#orgbdc8dd5">run tests</a></li>
<li><a href="#orgc178ae2">test suite</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgac988ad">manual</a>
<ul>
<li><a href="#org17fe919">ck configuration</a></li>
<li><a href="#orgeb1a91b">Actions</a>
<ul>
<li><a href="#orga34159d">init</a></li>
<li><a href="#orgfcddcc0">add</a></li>
<li><a href="#orgb841b44">list</a></li>
<li><a href="#org1acb8b9">search</a></li>
<li><a href="#org511c981">edit</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<p align="center"><img src="res/logo.png" width="30%" height="30%" /></p>
<div id="outline-container-org1d54245" class="outline-2">
<h2 id="org1d54245">ck</h2>
<div class="outline-text-2" id="text-org1d54245">
<p>
<b>The Config Keeper</b>
</p>
</div>
</div>

<div id="outline-container-org0f23886" class="outline-2">
<h2 id="org0f23886">build it</h2>
<div class="outline-text-2" id="text-org0f23886">
</div>
<div id="outline-container-org633fb0e" class="outline-3">
<h3 id="org633fb0e">requirements</h3>
<div class="outline-text-3" id="text-org633fb0e">
<ul class="org-ul">
<li>clang (llvm) or gcc (gnu)</li>
<li>cmake</li>
<li>sqlite3-dev</li>
</ul>
</div>
</div>

<div id="outline-container-org132a993" class="outline-3">
<h3 id="org132a993">compiler</h3>
<div class="outline-text-3" id="text-org132a993">
<div class="org-src-container">
<pre class="src src-sh">&gt; export <span style="color: #ffac4a;">CC</span>=clang
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">or</span>
&gt; export <span style="color: #ffac4a;">CC</span>=gcc
</pre>
</div>
</div>
</div>

<div id="outline-container-orgad56911" class="outline-3">
<h3 id="orgad56911">make</h3>
<div class="outline-text-3" id="text-orgad56911">
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">clone the repo</span>
&gt; cd ~/code; git clone https://gitlab.com/grm-grm/ck
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">make a build directory and enter it</span>
&gt; mkdir ~/ck_build; <span style="color: #ff0066;">cd</span> ~/ck_build;
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run cmake</span>
&gt; cmake ~/code/ck
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run make</span>
&gt; make
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run ck</span>
&gt; ./ck
</pre>
</div>
</div>
</div>
</div>

<div id="outline-container-orgb2415b8" class="outline-2">
<h2 id="orgb2415b8">for devs</h2>
<div class="outline-text-2" id="text-orgb2415b8">
</div>
<div id="outline-container-orgfebd554" class="outline-3">
<h3 id="orgfebd554">CMake options</h3>
<div class="outline-text-3" id="text-orgfebd554">
<p>
cmake accepts the following options:
</p>
<div class="org-src-container">
<pre class="src src-cmake"><span style="color: #63de5d;">option</span>(CK_ASAN <span style="color: #E6DB74;">"Build with asan"</span>)
<span style="color: #63de5d;">option</span>(CK_DEBUG <span style="color: #E6DB74;">"Build with debug symbols"</span>)
<span style="color: #63de5d;">option</span>(CK_TESTS <span style="color: #E6DB74;">"Make the tests"</span>)
<span style="color: #63de5d;">option</span>(CK_SHARED <span style="color: #E6DB74;">"Build with shared lib"</span>)
</pre>
</div>

<p>
To use any one of them append it after the cmake command like so:
</p>
<div class="org-src-container">
<pre class="src src-sh">cmake -DCK_ASAN=1 -DCK_DEBUG=1 -DCK_TESTS=1 ~/code/ck
</pre>
</div>

<p>
Just build with address sanitizer enabled like so:
llvm has better asan than gcc, so I use that.
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">clone the repo</span>
&gt; cd ~/code; git clone https://gitlab.com/grm-grm/ck
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">make a build directory and enter it</span>
&gt; mkdir ~/ck_build; <span style="color: #ff0066;">cd</span> ~/ck_build;
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run cmake</span>
&gt; cmake -DCK_ASAN=1 -DCK_DEBUG=1 -DCK_TESTS=1 ~/code/ck
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run make</span>
&gt; make
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">run ck</span>
&gt; ./ck
</pre>
</div>
</div>
</div>

<div id="outline-container-orgba141a7" class="outline-3">
<h3 id="orgba141a7">tests</h3>
<div class="outline-text-3" id="text-orgba141a7">
<p>
The testing "suite" is a bash script that runs regression
and unit tests. Regression tests are under the <code>tests/</code> directory
and are bash scripts that test <code>ck</code> functionality. Unit tests reside
under <code>unit/</code> directory and test the code.
</p>
</div>

<div id="outline-container-orgbdc8dd5" class="outline-4">
<h4 id="orgbdc8dd5">run tests</h4>
<div class="outline-text-4" id="text-orgbdc8dd5">
<p>
Simply go to the build dir and type.
</p>
<div class="org-src-container">
<pre class="src src-sh">$ ./check_ck
</pre>
</div>
</div>
</div>

<div id="outline-container-orgc178ae2" class="outline-4">
<h4 id="orgc178ae2">test suite</h4>
<div class="outline-text-4" id="text-orgc178ae2">
<div class="org-src-container">
<pre class="src src-sh">$ ./check_ck -h
ck test suite
use without flags to run all tests

flags:
  -u, --unit            run only the unit tests
  -r, --regression      run only the regression tests
  -c, --clear           remove test files
                         use it if the tests fail
  -h, --help, *         print this
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-orgac988ad" class="outline-2">
<h2 id="orgac988ad">manual</h2>
<div class="outline-text-2" id="text-orgac988ad">
<p>
ck's goal is to assist with the configuration file management.
To that end it tries to provides a cli interface that is pretty straight-forward
and intuitive.
</p>

<p>
Example usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">initialize new ck</span>
$ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #E6DB74; font-weight: bold;">\</span>
  /path_to/the_secret/directory

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">add emacs configs</span>
<span style="color: #6A6D70;">## </span><span style="color: #6A6D70;">primary config</span>
$ ck add emacs ~/.emacs.d/orgconf.org -p
<span style="color: #6A6D70;">## </span><span style="color: #6A6D70;">secret config, with passwords and naughty words</span>
$ ck add emacs ~/.emacs.d/accounts.org -s
<span style="color: #6A6D70;">## </span><span style="color: #6A6D70;">and another one for emacs</span>
$ ck add emacs ~/.emacs.d/init.el

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">add tmux config</span>
$ ck add tmux ~/.tmux.conf -p

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">list the configs</span>
$ ck list tree
$ ck list paths -t lisp
$ ck list programs -t python

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">search the configs</span>
$ ck search search-term
$ ck search <span style="color: #E6DB74;">"\"search term with spaces\""</span>
$ ck search <span style="color: #E6DB74;">"\("</span> <span style="color: #6A6D70;">#</span><span style="color: #6A6D70;">escape symbols</span>
</pre>
</div>

<p>
The first command after typing <b>ck</b> is the action you wish to perform. Actions are 
a very important concept of ck. With an action you can initialize <b>ck</b>, add/move/delete
configuration files to it, edit them, list them in various ways and search in their content.
</p>

<p>
Actions expect their arguments in the order specified below. This is done to reduce the amount
of flags one has to pass to ck.
</p>
</div>

<div id="outline-container-org17fe919" class="outline-3">
<h3 id="org17fe919">ck configuration</h3>
<div class="outline-text-3" id="text-org17fe919">
<p>
ck uses sqlite to index the configuration files. The init
action creates a <b>.ck</b> directory (under $HOME)
in witch the <b>ckrc</b> and the <b>ckdb</b> reside. The first one contains
the two directories described above while the other one is the
sqlite db.
</p>

<p>
One can have multiple config directories with different configurations
each.
</p>

<p>
Using the special keyword <b>config</b> (or <b>conf</b> or <b>c</b> or <b>-c</b>) you can set the path
in which ck will search for the <b>.ck</b> directory.
</p>

<p>
You can prefix every action with this and ck will use the configuration
directory of your choice.
</p>

<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh">$ ck config ~/ ... <span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">the default behaviour</span>

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">/someplace/else must exist or</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">the action following it must be init</span>
$ ck conf /someplace/else ... 

<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">same thing</span>
$ ck c /someplace/else ... 
$ ck -c /someplace/else ... 
</pre>
</div>
</div>
</div>

<div id="outline-container-orgeb1a91b" class="outline-3">
<h3 id="orgeb1a91b">Actions</h3>
<div class="outline-text-3" id="text-orgeb1a91b">
</div>
<div id="outline-container-orga34159d" class="outline-4">
<h4 id="orga34159d">init</h4>
<div class="outline-text-4" id="text-orga34159d">
<p>
or i or -i
</p>

<p>
init takes exactly 2 arguments.
</p>

<ul class="org-ul">
<li><b>config_dir</b>: where all the configs will live</li>
<li><b>secret_dir</b>: where all the secret configs will live</li>
</ul>

<p>
Use init to initialize a new ck database.
</p>

<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">initialize new ck</span>
$ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #E6DB74; font-weight: bold;">\</span>
  /path_to/the_secret/directory
</pre>
</div>
</div>
</div>

<div id="outline-container-orgfcddcc0" class="outline-4">
<h4 id="orgfcddcc0">add</h4>
<div class="outline-text-4" id="text-orgfcddcc0">
<p>
or a or -a
</p>

<p>
Adds a configuration to the ck database.
Add takes 2 to 4 arguments.
</p>

<ul class="org-ul">
<li><b>program_name</b>: the name of the program you add a config to</li>
<li><b>config_path</b>: the path to the config</li>
<li>Optional: (order doesn't matter)
<ul class="org-ul">
<li><b>-p</b>: the config will be the primary (relevant on edit below)</li>
<li><b>-s</b>: the config will be stored in the secret_dir</li>
</ul></li>
</ul>

<p>
Keep in mind:
</p>
<ul class="org-ul">
<li>The config has to exist.</li>
<li>If you are adding a config to a program already existing in ckdb make
sure to use the same name.</li>
<li>Each program can have only one primary config.</li>
</ul>

<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">add config to ck</span>
$ ck add program_name config_path [-s] [-p]
</pre>
</div>
</div>
</div>

<div id="outline-container-orgb841b44" class="outline-4">
<h4 id="orgb841b44">list</h4>
<div class="outline-text-4" id="text-orgb841b44">
<p>
or ls or l or -l
</p>

<p>
List can show the <b>paths</b> or the <b>programs</b> that ck keeps track of.
</p>

<p>
With the flag <b>-t</b> and then one of the follwing types one can change
the way the list is printed:
</p>
<ul class="org-ul">
<li><b>plain</b>: simple listing (default)</li>
<li><b>python</b>: print like a python list</li>
<li><b>lisp</b>: print like a lisp list</li>
</ul>

<p>
Using the keyword <b>tree</b> ck can list the configurations under their
corresponding program.
</p>

<p>
Passing the <b>-a</b> flag will enable the listing of config attributes (secret or primary). 
It is best used with tree or plain paths.
</p>

<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">list tree structure, with attributes</span>
$ ck list tree -a
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">list paths in python</span>
$ ck l paths -t python
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">list programs in lisp</span>
$ ck ls programs -t lisp
</pre>
</div>
</div>
</div>

<div id="outline-container-org1acb8b9" class="outline-4">
<h4 id="org1acb8b9">search</h4>
<div class="outline-text-4" id="text-org1acb8b9">
<p>
or s or -s
</p>

<p>
Perform infile grep in all the configurations ck keeps track of.
</p>

<p>
Takes one argument, the <b>search-term</b>.
</p>

<p>
To search for terms with spaces you have to put them in quotes.
</p>

<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">search for parenthesis</span>
$ ck search <span style="color: #E6DB74;">\(</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">search term with spaces</span>
$ ck search <span style="color: #E6DB74;">"This is a space"</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">both</span>
$ ck search <span style="color: #E6DB74;">"(add 2 4)"</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">and a normal one</span>
$ ck search alias
</pre>
</div>

<p>
If you want to use more advanced grep techniques or even
a different pattern matching program you can do it like so:
</p>

<div class="org-src-container">
<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">with xargs</span>
$ ck ls paths | xargs grep -E <span style="color: #E6DB74;">'A|B'</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">or in bash</span>
$ for i<span style="color: #ff0066;"> in</span> $(ck ls paths); <span style="color: #ff0066;">do</span> grep -E <span style="color: #E6DB74;">'A|B'</span> $<span style="color: #ffac4a;">i</span>; <span style="color: #ff0066;">done</span>
<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">or in zsh</span>
$ for i ($(ck ls paths)) grep -E <span style="color: #E6DB74;">'A|B'</span> $<span style="color: #ffac4a;">i</span>
</pre>
</div>
</div>
</div>

<div id="outline-container-org511c981" class="outline-4">
<h4 id="org511c981">edit</h4>
<div class="outline-text-4" id="text-org511c981">
<p>
or e or -e
</p>

<p>
<code>=--WIP--=</code>
</p>

<p>
Currently edit can only edit the primary config of a program.
</p>

<p>
To do it use:
</p>
<div class="org-src-container">
<pre class="src src-sh">$ ck edit program_name
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2018-09-28 Fri 23:23</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>