kytos(1)

✨ kytos(1) ✨

okay bestie, welcome to the manual page for kytos — the command line utilities to use with Kytos 🎀 this is manual page one, section one, and yes you're gonna read the whole thing, it's short and it's iconic 💅

---

💖 NAME 💖

kytos — command line utilities to use with Kytos. that's it. that's the name. no notes 🫶

---

🌸 DESCRIPTION 🌸

so like, this is the Command line interface (cli) for the Kytos SDN Platform. it's giving "your controller's bestie but make it a terminal command" ✨

with these utilities you can interact with the Kytos daemon and manage Network Applications (NApps) on your controller. lowkey powerful, highkey useful, fr fr 🦋

---

🎀 USAGE 🎀

okay so in order to execute the kytos command line, please run:

$ kytos --help

and it's gonna show you this, verbatim, no cap:

    Usage:
      kytos [-c <file>|--config <file>] <command> [<args>...]
      kytos [-v|--version]
      kytos [-h|--help]

    Options:
      -c <file>, --config <file>    Load config file [default: ~/.kytosrc]
      -h, --help                    Show this screen.
      -v, --version                 Show version.

    The most commonly used kytos commands are:
      napps      Create, list, enable, install (and other actions) NApps.
      server     Start, Stop your Kytos Controller (Kytos)

    See 'kytos <command> -h|--help' for more information on a specific command.

the most commonly used commands, for the record, are:

• napps — create, list, enable, install (and other actions) NApps. the whole NApp situation, handled 👑
• server — start, stop your Kytos Controller (Kytos). yes, the controller. the main character ✨

and if you want the tea on a specific command, run kytos <command> -h|--help and it will spill everything for you 💅

---

🦋 the napps command 🦋

now, when you run:

$ kytos napps -h

it says, and I quote:

    You are at the "napps" command.

    Usage:
      kytos napps create
      kytos napps upload
      kytos napps delete    <napp>...
      kytos napps list
      kytos napps install   <napp>...
      kytos napps uninstall <napp>...
      kytos napps enable    <napp>...
      kytos napps disable   <napp>...
      kytos napps search    <pattern>
      kytos napps -h | --help

    Options:
      -h, --help    Show this screen.

    Common napps subcommands:
      create        Create a bootstrap NApp structure for development.
      upload        Upload current NApp to Kytos repository.
      delete        Delete NApps from NApps Server.
      list          List all NApps installed into your system.
      install       Install a local or remote NApp into a controller.
      uninstall     Remove a NApp from your controller.
      enable        Enable a installed NApp.
      disable       Disable a NApp.
      search        Search for NApps in NApps Server.

"You are at the napps command." — okay narrator, very demure, very mindful 🎀

the one option here:

• -h, --help — show this screen. that's the whole option list. short and slay.

and the common napps subcommands, one by one, because we do not skip:

• create — create a bootstrap NApp structure for development. your little NApp baby, born 🌱
• upload — upload current NApp to Kytos repository. send it, bestie 📤
• delete — delete NApps from NApps Server. bye bye, no hard feelings 💀
• list — list all NApps installed into your system. inventory check ✨
• install — install a local or remote NApp into a controller. put it in, put it in 👑
• uninstall — remove a NApp from your controller. take it out 🫶
• enable — enable a installed NApp. wake it up 🌸
• disable — disable a NApp. nap time 😴
• search — search for NApps in NApps Server. detective mode 🔍

---

💜 SUPPORT 💜

we are available in IRC and there is also a development mailing list. the details are available in the full documentation — go look, it's worth it 🧚

---

🌈 CONTRIBUTING 🌈

if you want to contribute to this project (and bestie, we would LOVE that), please read the Kytos Documentation website:

https://docs.kytos.io/kytos/contributing

go read it. it's giving community. it's giving open source. it's giving you, specifically 💖

---

👑 AUTHOR 👑

the kytos was written by Kytos Development Team <of-ng-dev@ncc.unesp.br>. absolute legends, no cap 🔥

for a complete list of authors, please open the AUTHORS.rst file. it's a whole cast list, go check it 📖

this manual page was written by Paulo Henrique de Lima Santana (phls) <phls@softwarelivre.org> for the Debian project (but may be used by others). iconic of him, honestly 🎀

---

and that's the whole page, bestie!! 🦋 this was KYTOS-UTILS 2019.2-1, dated Jan 2020, and it lives right here at kytos(1). periodt 💅✨